diff --git a/src/Gui/AxisOriginPy.xml b/src/Gui/AxisOriginPy.xml deleted file mode 100644 index 6d8d0bd2c5..0000000000 --- a/src/Gui/AxisOriginPy.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Gui.AxisOrigin class. - -Class for creating a Coin3D representation of a coordinate system. - - - - getElementPicked(pickedPoint) -> str - -Returns the picked element name. - -pickedPoint : coin.SoPickedPoint - - - - - getDetailPath(subname, path) -> coin.SoDetail or None - -Returns Coin detail of a subelement. -Note: Not fully implemented. Currently only returns None. - -subname : str - String reference to the subelement. -path: coin.SoPath - Output Coin path leading to the returned element detail. - - - - - Get/set the axis length. - - - - - - Get/set the axis line width for rendering. - - - - - - Get/set the origin point size for rendering. - - - - - - Get/set auto scaling factor, 0 to disable. - - - - - - Get/set axis plane size and distance to axis line. - - - - - - Get/set axis component names as a dictionary. -Available keys are: -'O': origin -'X': x axis -'Y': y axis -'Z': z axis -'XY': xy plane -'XZ': xz plane -'YZ': yz plane - - - - - - Get the Coin3D node. - - - - - diff --git a/src/Gui/CMakeLists.txt b/src/Gui/CMakeLists.txt index 723e740976..2c1acb63d4 100644 --- a/src/Gui/CMakeLists.txt +++ b/src/Gui/CMakeLists.txt @@ -270,51 +270,38 @@ if(FREECAD_USE_PYSIDE) add_definitions(-DHAVE_PYSIDE${PYSIDE_MAJOR_VERSION}) endif(FREECAD_USE_PYSIDE) -generate_from_xml(DocumentPy) generate_from_py(Document) -generate_from_xml(PythonWorkbenchPy) generate_from_py(PythonWorkbench) -generate_from_xml(ViewProviderPy) generate_from_py(ViewProvider) -generate_from_xml(ViewProviderDocumentObjectPy) generate_from_py(ViewProviderDocumentObject) -generate_from_xml(ViewProviderGeometryObjectPy) generate_from_py(ViewProviderGeometryObject) -generate_from_xml(ViewProviderExtensionPy) generate_from_py(ViewProviderExtension) -generate_from_xml(WorkbenchPy) generate_from_py(Workbench) -generate_from_xml(Selection/SelectionObjectPy) generate_from_py(Selection/SelectionObject) -generate_from_xml(LinkViewPy) generate_from_py(LinkView) -generate_from_xml(ViewProviderLinkPy) generate_from_py(ViewProviderLink) -generate_from_xml(AxisOriginPy) generate_from_py(AxisOrigin) -generate_from_xml(CommandPy) generate_from_py(Command) -generate_from_xml(Navigation/NavigationStylePy) generate_from_py(Navigation/NavigationStyle) generate_embed_from_py(FreeCADGuiInit GuiInitScript.h) -# The XML files -SET(FreeCADGui_XML_SRCS - ViewProviderDocumentObjectPy.xml - ViewProviderGeometryObjectPy.xml - ViewProviderPy.xml - ViewProviderExtensionPy.xml - PythonWorkbenchPy.xml - WorkbenchPy.xml - Selection/SelectionObjectPy.xml - DocumentPy.xml - LinkViewPy.xml - ViewProviderLinkPy.xml - AxisOriginPy.xml - CommandPy.xml +# The Pyi files +SET(FreeCADGui_Pyi_SRCS + ViewProviderDocumentObject.pyi + ViewProviderGeometryObject.pyi + ViewProvider.pyi + ViewProviderExtension.pyi + PythonWorkbench.pyi + Workbench.pyi + Selection/SelectionObject.pyi + Document.pyi + LinkView.pyi + ViewProviderLink.pyi + AxisOrigin.pyi + Command.pyi ) -SOURCE_GROUP("XML" FILES ${FreeCADApp_XML_SRCS}) +SOURCE_GROUP("Pyi" FILES ${FreeCADGui_Pyi_SRCS}) # The 3D Connexion SDK files if(FREECAD_USE_3DCONNEXION_LEGACY AND MSVC) @@ -960,7 +947,7 @@ SET(Navigation_CPP_SRCS SET(Navigation_SRCS ${Navigation_CPP_SRCS} Navigation/NavigationStyle.h - Navigation/NavigationStylePy.xml + Navigation/NavigationStyle.pyi Navigation/GestureNavigationStyle.h Navigation/NavigationAnimator.h Navigation/NavigationAnimation.h diff --git a/src/Gui/CommandPy.xml b/src/Gui/CommandPy.xml deleted file mode 100644 index 2fa2f65639..0000000000 --- a/src/Gui/CommandPy.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - FreeCAD Python wrapper of Command functions - - - - get(name) -> Gui.Command or None - -Get a given command by name or None if it doesn't exist. - -name : str - Command name. - - - - - update() -> None - -Update active status of all commands. - - - - - listAll() -> list of str - -Returns the name of all commands. - - - - - listByShortcut(string, useRegExp=False) -> list of str - -Returns a list of all commands, filtered by shortcut. -Shortcuts are converted to uppercase and spaces removed -prior to comparison. - -string : str - Shortcut to be searched. -useRegExp : bool - Filter using regular expression. - - - - - run(item=0) -> None - -Runs the given command. - -item : int - Item to be run. - - - - - isActive() -> bool - -Returns True if the command is active, False otherwise. - - - - - getShortcut() -> str - -Returns string representing shortcut key accelerator for command. - - - - - setShortcut(string) -> bool - -Sets shortcut for given command, returns True for success. - -string : str - Shortcut to be set. - - - - - resetShortcut() -> bool - -Resets shortcut for given command back to the default, returns True for success. - - - - - getInfo() -> dict - -Return information about this command. - - - - - getAction() -> list of QAction - -Return the associated QAction object. - - - - - createCustomCommand(macroFile, menuText, toolTip, whatsThis, statusTip, pixmap, shortcut) -> str - -Create a custom command for a macro. Returns name of the created command. - -macroFile : str - Macro file. -menuText : str - Menu text. Optional. -toolTip : str - Tool tip text. Optional. -whatsThis : str - `What's this?` text. Optional. -statusTip : str - Status tip text. Optional. -pixmap : str - Pixmap name. Optional. -shortcut : str - Shortcut key sequence. Optional. - - - - - removeCustomCommand(name) -> bool - -Remove the custom command if it exists. -Given the name of a custom command, this removes that command. -It is not an error to remove a non-existent command, the function -simply does nothing in that case. -Returns True if something was removed, or False if not. - -name : str - Command name. - - - - - findCustomCommand(name) -> str or None - -Given the name of a macro, return the name of the custom command for that macro -or None if there is no command matching that macro script name. - -name : str - Macro name. - - - - diff --git a/src/Gui/DocumentPy.xml b/src/Gui/DocumentPy.xml deleted file mode 100644 index 2823a7acc4..0000000000 --- a/src/Gui/DocumentPy.xml +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - This is a Document class - - - - show(objName) -> None - -Show an object. - -objName : str - Name of the `Gui.ViewProvider` to show. - - - - - hide(objName) -> None - -Hide an object. - -objName : str - Name of the `Gui.ViewProvider` to hide. - - - - - setPos(objName, matrix) -> None - -Set the position of an object. - -objName : str - Name of the `Gui.ViewProvider`. - -matrix : Base.Matrix - Transformation to apply on the object. - - - - - setEdit(obj, mod=0, subName) -> bool - -Set an object in edit mode. - -obj : str, App.DocumentObject, Gui.ViewPrivider - Object to set in edit mode. -mod : int - Edit mode. -subName : str - Subelement name. Optional. - - - - - getInEdit() -> Gui.ViewProviderDocumentObject or None - -Returns the current object in edit mode or None if there is no such object. - - - - - resetEdit() -> None - -End the current editing. - - - - - addAnnotation(annoName, fileName, modName) -> None - -Add an Inventor object from a file. - -annoName : str - Annotation name. -fileName : str - File name. -modName : str - Display mode name. Optional. - - - - - update() -> None - -Update the view representations of all objects. - - - - - getObject(objName) -> object or None - -Return the object with the given name. If no one exists, return None. - -ObjName : str - Object name. - - - - - activeObject() -> object or None - -The active object of the document. Deprecated, use ActiveObject. - - - - - activeView() -> object or None - -The active view of the document. Deprecated, use ActiveView. - - - - - createView(type) -> object or None - -Return a newly created view of a given type. - -type : str - Type name. - - - - - mdiViewsOfType(type) -> list of MDIView - -Return a list of mdi views of a given type. - -type : str - Type name. - - - - - save() -> bool - -Attempts to save the document - - - - - saveAs() -> bool - -Attempts to save the document under a new name - - - - - sendMsgToViews(msg) -> None - -Send a message to all views of the document. - -msg : str - - - - - mergeProject(fileName) -> None - -Merges this document with another project file. - -fileName : str - File name. - - - - - toggleTreeItem(obj, mod=0, subName) -> None - -Change TreeItem of a document object. - -obj : App.DocumentObject -mod : int - Item mode. - 0: Toggle, 1: Collapse, 2: Expand, 3: Expand path. -subName : str - Subelement name. Optional. - - - - - scrollToTreeItem(obj) -> None - -Scroll the tree view to the item of a view object. - -obj : Gui.ViewProviderDocumentObject - - - - - toggleInSceneGraph(obj) -> None - -Add or remove view object from scene graph of all views depending -on its canAddToSceneGraph(). - -obj : Gui.ViewProvider - - - - - The active object of the document. - - - - - - The active view of the document. - - - - - - The editing transformation matrix. - - - - - - A tuple(obj,subname,subElement,editMode) of editing object reference, or None if no object is in edit. - - - - - - Current edit mode. Only meaningful when there is a current object in edit. - - - - - - The related App document to this Gui document. - - - - - - Indicate whether the document is undoing/redoing. - - - - - - Returns True if the document is marked as modified, and False otherwise. - - - - - - The list of tree root objects. - - - - - diff --git a/src/Gui/LinkViewPy.xml b/src/Gui/LinkViewPy.xml deleted file mode 100644 index 70abbe9871..0000000000 --- a/src/Gui/LinkViewPy.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - Helper class to link to a view object - - - - Reset the link view and clear the links - - - - - -setMaterial(Material): set the override material of the entire linked object - -setMaterial([Material,...]): set the materials for the elements of the link - array/group. - -setMaterial({Int:Material,...}): set the material for the elements of the - link array/group by index. - -If material is None, then the material is unset. If the material of an element -is unset, it defaults to the override material of the linked object, if there -is one - - - - - - -setType(type, sublink=True): set the link type. - -type=0: override transformation and visibility -type=1: override visibility -type=2: no override -type=-1: sub-object link with override visibility -type=-2: sub-object link with override transformation and visibility - -sublink: auto delegate to the sub-object references in the link, if there is - one and only one. - - - - - - -setTransform(matrix): set transformation of the linked object - -setTransform([matrix,...]): set transformation for the elements of the link - array/group - -setTransform({index:matrix,...}): set transformation for elements of the link - array/group by index - - - - - - -setChildren([obj...],vis=[],type=0) -Group a list of children objects. Note, this mode of operation is incompatible -with link array. Calling this function will deactivate link array. And calling -setSize() will reset all linked children. - -vis: initial visibility status of the children - -type: children linking type, - 0: override transformation and visibility, - 1: override visibility, - 2: override none. - - - - - - -setLink(object): Set the link - -setLink(object, subname): Set the link with a sub-object reference - -setLink(object, [subname,...]): Set the link with a list of sub object references - -object: The linked document object or its view object - -subname: a string or tuple/list of strings sub-name references to sub object - or sub elements (e.g. Face1, Edge2) belonging to the linked object. - The sub-name must end with a '.' if it is referencing an sub-object, - or else it is considered a sub-element reference. - - - - - - -getDetailPath(element): get the 3d path an detail of an element. - -Return a tuple(path,detail) for the coin3D SoPath and SoDetail of the element - - - - - - getElementPicked(pickPoint): get the element under a 3d pick point. - - - - - getBoundBox(vobj=None): get the bounding box. - - - - - The linked view object - - - - - - The sub-object reference of the link - - - - - - A pivy node holding the cloned representation of the linked view object - - - - - - The owner view object of this link handle - - - - - - Get/set the child element visibility - - - - - - Set the element size to create an array of linked object - - - - - - Get children view objects - - - - diff --git a/src/Gui/Navigation/NavigationStylePy.xml b/src/Gui/Navigation/NavigationStylePy.xml deleted file mode 100644 index 314eda00ee..0000000000 --- a/src/Gui/Navigation/NavigationStylePy.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - This is the base class for navigation styles - - - - diff --git a/src/Gui/PythonWorkbenchPy.xml b/src/Gui/PythonWorkbenchPy.xml deleted file mode 100644 index 08ae38e86f..0000000000 --- a/src/Gui/PythonWorkbenchPy.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - This is the class for Python workbenches - - - - Append a new menu - - - - - Remove a menu - - - - - Append a new context menu item - - - - - Remove a context menu item - - - - - Append a new toolbar - - - - - Remove a toolbar - - - - - Append a new command bar - - - - - Remove a command bar - - - - - deprecated -- use appendMenu - - - - - deprecated -- use removeMenu - - - - - deprecated -- use listMenus - - - - - deprecated -- use appendContextMenu - - - - - deprecated -- use removeContextMenu - - - - - deprecated -- use appendToolbar - - - - - deprecated -- use removeToolbar - - - - - deprecated -- use listToolbars - - - - - deprecated -- use appendCommandBar - - - - - deprecated -- use removeCommandBar - - - - - deprecated -- use listCommandBars - - - - - diff --git a/src/Gui/Selection/SelectionObjectPy.xml b/src/Gui/Selection/SelectionObjectPy.xml deleted file mode 100644 index 5cd194e455..0000000000 --- a/src/Gui/Selection/SelectionObjectPy.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - This class represents selections made by the user. It holds information about the object, document and sub-element of the selection. - - - - Remove this selection item from the selection. -remove() -> None --- -This object becomes invalid. - - - - - - Test for a certain father class. -isObjectTypeOf(type) -> Bool - - - - - - Name of the selected object - - - - - - Name of the selected sub-element if any - - - - - - Name of the selected object - - - - - - Type name of the selected object - - - - - - Name of the document of the selected object - - - - - - Document of the selected object - - - - - - Selected object - - - - - - Selected sub-element, if any - - - - - - Picked points for selection - - - - - - Selected sub-element, if any - - - - - - diff --git a/src/Gui/ViewProviderDocumentObjectPy.xml b/src/Gui/ViewProviderDocumentObjectPy.xml deleted file mode 100644 index c2fa0dc08d..0000000000 --- a/src/Gui/ViewProviderDocumentObjectPy.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - This is the ViewProvider base class - - - - Update the view representation of the object - - - - - Set/Get the associated data object - - - - - - Reference count to force update visual - - - - - - Return the document the view provider is part of - - - - - diff --git a/src/Gui/ViewProviderExtensionPy.xml b/src/Gui/ViewProviderExtensionPy.xml deleted file mode 100644 index f5eb37fc61..0000000000 --- a/src/Gui/ViewProviderExtensionPy.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - Base class for all view provider extensions - - - - Ignore the overlay icon of an extension - - - - - Ignore the overlay icon of an extension - - - - - diff --git a/src/Gui/ViewProviderGeometryObjectPy.xml b/src/Gui/ViewProviderGeometryObjectPy.xml deleted file mode 100644 index a33a742568..0000000000 --- a/src/Gui/ViewProviderGeometryObjectPy.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - This is the ViewProvider geometry class - - - - getUserDefinedMaterial() -> object - -Get a material object with the user-defined colors. - - - - - diff --git a/src/Gui/ViewProviderLinkPy.xml b/src/Gui/ViewProviderLinkPy.xml deleted file mode 100644 index 09641c2cf8..0000000000 --- a/src/Gui/ViewProviderLinkPy.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - This is the ViewProviderLink class - - - - Get/set dragger placement during dragging - - - - - - Get the associated LinkView object - - - - - diff --git a/src/Gui/ViewProviderPy.xml b/src/Gui/ViewProviderPy.xml deleted file mode 100644 index ad5c5c6365..0000000000 --- a/src/Gui/ViewProviderPy.xml +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - This is the ViewProvider base class - - - - addProperty(type, name, group, doc, attr=0, ro=False, hd=False) -> ViewProvider - -Add a generic property. - -type : str - Property type. -name : str - Property name. Optional. -group : str - Property group. Optional. -attr : int - Property attributes. -ro : bool - Read only property. -hd : bool - Hidden property. - - - - - removeProperty(name) -> bool - -Remove a generic property. -Only user-defined properties can be removed, not built-in ones. - -name : str - Property name. - - - - - supportedProperties() -> list - -A list of supported property types. - - - - - show() -> None - -Show the object. - - - - - hide() -> None - -Hide the object. - - - - - isVisible() -> bool - -Check if the object is visible. - - - - - canDragObject(obj=None) -> bool - -Check whether the child object can be removed by dragging. -If 'obj' is not given, check without filter by any particular object. - -obj : App.DocumentObject - Object to be dragged. - - - - - dragObject(obj) -> None - -Remove a child object by dropping. - -obj : App.DocumentObject - Object to be dragged. - - - - - canDropObject(obj=None, owner=None, subname, elem=None) -> bool - -Check whether the child object can be added by dropping. -If 'obj' is not given, check without filter by any particular object. - -obj : App.DocumentObject - Object to be dropped. -owner : App.DocumentObject - Parent object of the dropping object. -subname : str - Subname reference to the dropping object. Optional. -elem : sequence of str - Non-objects subelements selected when the object is - being dropped. - - - - - dropObject(obj, owner=None, subname, elem=None) -> str - -Add a child object by dropping. - -obj : App.DocumentObject - Object to be dropped. -owner : App.DocumentObject - Parent object of the dropping object. -subname : str - Subname reference to the dropping object. Optional. -elem : sequence of str - Non-objects subelements selected when the object is - being dropped. - - - - - canDragAndDropObject(obj) -> bool - -Check whether the child object can be removed from -other parent and added here by drag and drop. - -obj : App.DocumentObject - Object to be dragged and dropped. - - - - - replaceObject(oldObj, newObj) -> int - -Replace a child object. -Returns 1 if succeeded, 0 if not found, -1 if not supported. - -oldObj : App.DocumentObject - Old object. -newObj : App.DocumentObject - New object. - - - - - doubleClicked() -> bool - -Trigger double clicking the corresponding tree item of this view object. - - - - - addDisplayMode(obj, mode) -> None - -Add a new display mode to the view provider. - -obj : coin.SoNode - Display mode. -mode : str - Name of the display mode. - - - - - listDisplayModes() -> list - -Show a list of all display modes. - - - - - toString() -> str - -Return a string representation of the Inventor node. - - - - - setTransformation(trans) -> None - -Set a transformation on the Inventor node. - -trans : Base.Placement, Base.Matrix - - - - - claimChildren() -> list - -Returns list of objects that are to be grouped in tree under this object. - - - - - claimChildrenRecursive() -> list - -Returns list of objects that are to be grouped in tree under this object recursively. - - - - - partialRender(sub=None, clear=False) -> int - -Render only part of the object. - -sub: None, str, sequence of str - Refer to the subelement. If it is None then reset the partial rendering. -clear: bool - True to add, or False to remove the subelement(s) for rendering. - - - - - getElementColors(elementName) -> dict - -Get a dictionary of the form {elementName : (r,g,b,a)}. -If no element name is given a dictionary with all the elements is returned. - -elementName : str - Name of the element. Optional. - - - - - setElementColors(colors) -> None - -Set element colors. - -colors: dict - Color dictionary of the form {elementName:(r,g,b,a)}. - - - - - getElementPicked(pickPoint) -> str - -Return the picked subelement. - -pickPoint : coin.SoPickedPoint - - - - - getDetailPath(subelement, path, append=True) -> coin.SoDetail or None - -Return Coin detail and path of an subelement. - -subname: str - Dot separated string reference to the sub element. -pPath: coin.SoPath - Output coin path leading to the returned element detail. -append: bool - If True, path will be first appended with the root node and the mode - switch node of this view provider. - - - - - signalChangeIcon() -> None - -Trigger icon changed signal. - - - - - getBoundingBox(subName, transform=True, view) -> Base.BoundBox - -Obtain the bounding box of this view object. - -subName : str - Name referring a sub-object. Optional. -transform: bool - Whether to apply the transformation matrix of this view provider. -view: View3DInventorPy - Default to active view. Optional. - - - - - A pivy Separator to add a custom scenegraph to this ViewProvider. - - - - - - The icon of this ViewProvider. - - - - - - A pivy Separator with the root of this ViewProvider. - - - - - - A pivy SoSwitch for the display mode switch of this ViewProvider. - - - - - - Get/Set the default display mode in turns of coin node index. - - - - - - Represents the whole ViewProvider as an Inventor string. - - - - - - Tells the tree view whether to remove the children item from root or not. - - - - - - Get/set visibilities of all links to this view object. - - - - - - Subname referencing the sub-object for holding dropped object. - - - - - diff --git a/src/Gui/WorkbenchPy.xml b/src/Gui/WorkbenchPy.xml deleted file mode 100644 index af5b8d9285..0000000000 --- a/src/Gui/WorkbenchPy.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - This is the base class for workbenches - - - - Return the workbench name - - - - - Activate this workbench - - - - - Show a list of all toolbars - - - - - Show a dict of all toolbars and their commands - - - - - Show a list of all command bars - - - - - Show a list of all menus - - - - - Reload the active workbench after changing menus or toolbars - - - - - diff --git a/src/Tools/bindings/templates/templateClassPyExport.py b/src/Tools/bindings/templates/templateClassPyExport.py index 76bcc95385..d3584c1417 100644 --- a/src/Tools/bindings/templates/templateClassPyExport.py +++ b/src/Tools/bindings/templates/templateClassPyExport.py @@ -37,7 +37,7 @@ def compareFiles(file1, file2): class TemplateClassPyExport(template.ModelTemplate): # TODO: This is temporary, once all XML files are migrated, this can be removed. def getPath(self, path): - if self.is_python and not self.export.ModuleName in ["Base", "App"]: + if self.is_python and not self.export.ModuleName in ["Base", "App", "Gui"]: root, ext = os.path.splitext(path) return f"{root}_{ext}" return path