Gui: Remove XML binding files.

This commit is contained in:
Joao Matos
2025-03-24 18:05:35 +00:00
committed by Benjamin Nauck
parent c5cbb864d8
commit 8a934297dc
15 changed files with 17 additions and 1453 deletions

View File

@@ -1,93 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="BaseClassPy"
Name="AxisOriginPy"
Twin="AxisOrigin"
TwinPointer="AxisOrigin"
Include="Gui/AxisOrigin.h"
Namespace="Gui"
FatherInclude="Base/BaseClassPy.h"
FatherNamespace="Base"
Constructor="true"
Delete="true">
<Documentation>
<Author Licence="LGPL" Name="Zheng, Lei" EMail="realthunder.dev@gmail.com" />
<UserDocu>Gui.AxisOrigin class.
Class for creating a Coin3D representation of a coordinate system.</UserDocu>
</Documentation>
<Methode Name="getElementPicked" Const="true">
<Documentation>
<UserDocu>getElementPicked(pickedPoint) -> str
Returns the picked element name.
pickedPoint : coin.SoPickedPoint</UserDocu>
</Documentation>
</Methode>
<Methode Name="getDetailPath" Const="true">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Attribute Name="AxisLength">
<Documentation>
<UserDocu>Get/set the axis length.</UserDocu>
</Documentation>
<Parameter Name="AxisLength" Type="Float" />
</Attribute>
<Attribute Name="LineWidth">
<Documentation>
<UserDocu>Get/set the axis line width for rendering.</UserDocu>
</Documentation>
<Parameter Name="LineWidth" Type="Float" />
</Attribute>
<Attribute Name="PointSize">
<Documentation>
<UserDocu>Get/set the origin point size for rendering.</UserDocu>
</Documentation>
<Parameter Name="PointSize" Type="Float" />
</Attribute>
<Attribute Name="Scale">
<Documentation>
<UserDocu>Get/set auto scaling factor, 0 to disable.</UserDocu>
</Documentation>
<Parameter Name="Scale" Type="Float" />
</Attribute>
<Attribute Name="Plane">
<Documentation>
<UserDocu>Get/set axis plane size and distance to axis line.</UserDocu>
</Documentation>
<Parameter Name="Plane" Type="Tuple" />
</Attribute>
<Attribute Name="Labels">
<Documentation>
<UserDocu>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</UserDocu>
</Documentation>
<Parameter Name="Labels" Type="Dict" />
</Attribute>
<Attribute Name="Node" ReadOnly='true'>
<Documentation>
<UserDocu>Get the Coin3D node.</UserDocu>
</Documentation>
<Parameter Name="Node" Type="Object" />
</Attribute>
</PythonExport>
</GenerateModel>

View File

@@ -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

View File

@@ -1,157 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="PyObjectBase"
Name="CommandPy"
Twin="Command"
TwinPointer="Command"
Include="Gui/Command.h"
FatherInclude="Base/PyObjectBase.h"
Namespace="Gui"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
<UserDocu>FreeCAD Python wrapper of Command functions</UserDocu>
</Documentation>
<Methode Name="get" Static='true'>
<Documentation>
<UserDocu>get(name) -> Gui.Command or None
Get a given command by name or None if it doesn't exist.
name : str
Command name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="update" Static='true'>
<Documentation>
<UserDocu>update() -> None
Update active status of all commands.</UserDocu>
</Documentation>
</Methode>
<Methode Name="listAll" Static='true'>
<Documentation>
<UserDocu>listAll() -> list of str
Returns the name of all commands.</UserDocu>
</Documentation>
</Methode>
<Methode Name="listByShortcut" Static='true'>
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="run">
<Documentation>
<UserDocu>run(item=0) -> None
Runs the given command.
item : int
Item to be run.</UserDocu>
</Documentation>
</Methode>
<Methode Name="isActive" Const="true">
<Documentation>
<UserDocu>isActive() -> bool
Returns True if the command is active, False otherwise.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getShortcut">
<Documentation>
<UserDocu>getShortcut() -> str
Returns string representing shortcut key accelerator for command.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setShortcut">
<Documentation>
<UserDocu>setShortcut(string) -> bool
Sets shortcut for given command, returns True for success.
string : str
Shortcut to be set.</UserDocu>
</Documentation>
</Methode>
<Methode Name="resetShortcut">
<Documentation>
<UserDocu>resetShortcut() -> bool
Resets shortcut for given command back to the default, returns True for success.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getInfo">
<Documentation>
<UserDocu>getInfo() -> dict
Return information about this command.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getAction">
<Documentation>
<UserDocu>getAction() -> list of QAction
Return the associated QAction object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="createCustomCommand" Static='true' Keyword='true'>
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeCustomCommand" Static='true'>
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="findCustomCommand" Static='true'>
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
</PythonExport>
</GenerateModel>

View File

@@ -1,263 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="PersistencePy"
Name="DocumentPy"
Twin="Document"
TwinPointer="Document"
Include="Gui/Document.h"
Namespace="Gui"
FatherInclude="Base/PersistencePy.h"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is a Document class</UserDocu>
</Documentation>
<Methode Name="show">
<Documentation>
<UserDocu>show(objName) -> None
Show an object.
objName : str
Name of the `Gui.ViewProvider` to show.</UserDocu>
</Documentation>
</Methode>
<Methode Name="hide">
<Documentation>
<UserDocu>hide(objName) -> None
Hide an object.
objName : str
Name of the `Gui.ViewProvider` to hide.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setPos">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setEdit">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getInEdit">
<Documentation>
<UserDocu>getInEdit() -> Gui.ViewProviderDocumentObject or None
Returns the current object in edit mode or None if there is no such object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="resetEdit">
<Documentation>
<UserDocu>resetEdit() -> None
End the current editing.</UserDocu>
</Documentation>
</Methode>
<Methode Name="addAnnotation">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="update">
<Documentation>
<UserDocu>update() -> None
Update the view representations of all objects.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getObject">
<Documentation>
<UserDocu>getObject(objName) -> object or None
Return the object with the given name. If no one exists, return None.
ObjName : str
Object name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="activeObject">
<Documentation>
<UserDocu>activeObject() -> object or None
The active object of the document. Deprecated, use ActiveObject.</UserDocu>
</Documentation>
</Methode>
<Methode Name="activeView">
<Documentation>
<UserDocu>activeView() -> object or None
The active view of the document. Deprecated, use ActiveView.</UserDocu>
</Documentation>
</Methode>
<Methode Name="createView">
<Documentation>
<UserDocu>createView(type) -> object or None
Return a newly created view of a given type.
type : str
Type name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="mdiViewsOfType" Const="true">
<Documentation>
<UserDocu>mdiViewsOfType(type) -> list of MDIView
Return a list of mdi views of a given type.
type : str
Type name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="save">
<Documentation>
<UserDocu>save() -> bool
Attempts to save the document</UserDocu>
</Documentation>
</Methode>
<Methode Name="saveAs">
<Documentation>
<UserDocu>saveAs() -> bool
Attempts to save the document under a new name</UserDocu>
</Documentation>
</Methode>
<Methode Name="sendMsgToViews">
<Documentation>
<UserDocu>sendMsgToViews(msg) -> None
Send a message to all views of the document.
msg : str</UserDocu>
</Documentation>
</Methode>
<Methode Name="mergeProject">
<Documentation>
<UserDocu>mergeProject(fileName) -> None
Merges this document with another project file.
fileName : str
File name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleTreeItem">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="scrollToTreeItem">
<Documentation>
<UserDocu>scrollToTreeItem(obj) -> None
Scroll the tree view to the item of a view object.
obj : Gui.ViewProviderDocumentObject</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleInSceneGraph">
<Documentation>
<UserDocu>toggleInSceneGraph(obj) -> None
Add or remove view object from scene graph of all views depending
on its canAddToSceneGraph().
obj : Gui.ViewProvider</UserDocu>
</Documentation>
</Methode>
<Attribute Name="ActiveObject" ReadOnly="false">
<Documentation>
<UserDocu>The active object of the document.</UserDocu>
</Documentation>
<Parameter Name="ActiveObject" Type="Object" />
</Attribute>
<Attribute Name="ActiveView" ReadOnly="false">
<Documentation>
<UserDocu>The active view of the document.</UserDocu>
</Documentation>
<Parameter Name="ActiveView" Type="Object" />
</Attribute>
<Attribute Name="EditingTransform">
<Documentation>
<UserDocu>The editing transformation matrix.</UserDocu>
</Documentation>
<Parameter Name="EditingTransform" Type="Object" />
</Attribute>
<Attribute Name="InEditInfo">
<Documentation>
<UserDocu>A tuple(obj,subname,subElement,editMode) of editing object reference, or None if no object is in edit.</UserDocu>
</Documentation>
<Parameter Name="InEditInfo" Type="Object" />
</Attribute>
<Attribute Name="EditMode" ReadOnly="true">
<Documentation>
<UserDocu>Current edit mode. Only meaningful when there is a current object in edit.</UserDocu>
</Documentation>
<Parameter Name="EditMode" Type="Long" />
</Attribute>
<Attribute Name="Document" ReadOnly="true">
<Documentation>
<UserDocu>The related App document to this Gui document.</UserDocu>
</Documentation>
<Parameter Name="Document" Type="Object" />
</Attribute>
<Attribute Name="Transacting" ReadOnly="true">
<Documentation>
<UserDocu>Indicate whether the document is undoing/redoing.</UserDocu>
</Documentation>
<Parameter Name="Transacting" Type="Boolean" />
</Attribute>
<Attribute Name="Modified">
<Documentation>
<UserDocu>Returns True if the document is marked as modified, and False otherwise.</UserDocu>
</Documentation>
<Parameter Name="Modified" Type="Boolean" />
</Attribute>
<Attribute Name="TreeRootObjects" ReadOnly="true">
<Documentation>
<UserDocu>The list of tree root objects.</UserDocu>
</Documentation>
<Parameter Name="TreeRootObjects" Type="List" />
</Attribute>
</PythonExport>
</GenerateModel>

View File

@@ -1,165 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="BaseClassPy"
Name="LinkViewPy"
Twin="LinkView"
TwinPointer="LinkView"
Include="Gui/ViewProviderLink.h"
Namespace="Gui"
FatherInclude="Base/BaseClassPy.h"
FatherNamespace="Base"
Constructor="true"
Delete="true">
<Documentation>
<Author Licence="LGPL" Name="Zheng, Lei" EMail="realthunder.dev@gmail.com" />
<UserDocu>Helper class to link to a view object</UserDocu>
</Documentation>
<Methode Name="reset">
<Documentation>
<UserDocu>Reset the link view and clear the links</UserDocu>
</Documentation>
</Methode>
<Methode Name="setMaterial">
<Documentation>
<UserDocu>
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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setType">
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setTransform">
<Documentation>
<UserDocu>
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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setChildren">
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setLink">
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getDetailPath">
<Documentation>
<UserDocu>
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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getElementPicked">
<Documentation>
<UserDocu>getElementPicked(pickPoint): get the element under a 3d pick point. </UserDocu>
</Documentation>
</Methode>
<Methode Name="getBoundBox">
<Documentation>
<UserDocu>getBoundBox(vobj=None): get the bounding box. </UserDocu>
</Documentation>
</Methode>
<Attribute Name="LinkedView" ReadOnly="true">
<Documentation>
<UserDocu>The linked view object</UserDocu>
</Documentation>
<Parameter Name="LinkedView" Type="Object" />
</Attribute>
<Attribute Name="SubNames" ReadOnly="true">
<Documentation>
<UserDocu>The sub-object reference of the link</UserDocu>
</Documentation>
<Parameter Name="SubNames" Type="Object" />
</Attribute>
<Attribute Name="RootNode" ReadOnly="true">
<Documentation>
<UserDocu>A pivy node holding the cloned representation of the linked view object</UserDocu>
</Documentation>
<Parameter Name="RootNode" Type="Object" />
</Attribute>
<Attribute Name="Owner">
<Documentation>
<UserDocu>The owner view object of this link handle</UserDocu>
</Documentation>
<Parameter Name="Owner" Type="Object" />
</Attribute>
<Attribute Name="Visibilities">
<Documentation>
<UserDocu>Get/set the child element visibility</UserDocu>
</Documentation>
<Parameter Name="Visibilities" Type="Object" />
</Attribute>
<Attribute Name="Count">
<Documentation>
<UserDocu>Set the element size to create an array of linked object</UserDocu>
</Documentation>
<Parameter Name="Count" Type="Long" />
</Attribute>
<Methode Name="getChildren" Const="true">
<Documentation>
<UserDocu>Get children view objects</UserDocu>
</Documentation>
</Methode>
</PythonExport>
</GenerateModel>

View File

@@ -1,18 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="BaseClassPy"
Name="NavigationStylePy"
Twin="NavigationStyle"
TwinPointer="NavigationStyle"
Include="Gui/Navigation/NavigationStyle.h"
Namespace="Gui"
FatherInclude="Base/BaseClassPy.h"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the base class for navigation styles</UserDocu>
</Documentation>
<CustomAttributes />
</PythonExport>
</GenerateModel>

View File

@@ -1,113 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="WorkbenchPy"
Name="PythonWorkbenchPy"
Twin="PythonBaseWorkbench"
TwinPointer="PythonBaseWorkbench"
Include="Gui/Workbench.h"
Namespace="Gui"
FatherInclude="Gui/WorkbenchPy.h"
FatherNamespace="Gui">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the class for Python workbenches</UserDocu>
</Documentation>
<Methode Name="appendMenu">
<Documentation>
<UserDocu>Append a new menu</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeMenu">
<Documentation>
<UserDocu>Remove a menu</UserDocu>
</Documentation>
</Methode>
<Methode Name="appendContextMenu">
<Documentation>
<UserDocu>Append a new context menu item</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeContextMenu">
<Documentation>
<UserDocu>Remove a context menu item</UserDocu>
</Documentation>
</Methode>
<Methode Name="appendToolbar">
<Documentation>
<UserDocu>Append a new toolbar</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeToolbar">
<Documentation>
<UserDocu>Remove a toolbar</UserDocu>
</Documentation>
</Methode>
<Methode Name="appendCommandbar">
<Documentation>
<UserDocu>Append a new command bar</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeCommandbar">
<Documentation>
<UserDocu>Remove a command bar</UserDocu>
</Documentation>
</Methode>
<Methode Name="AppendMenu">
<Documentation>
<UserDocu>deprecated -- use appendMenu</UserDocu>
</Documentation>
</Methode>
<Methode Name="RemoveMenu">
<Documentation>
<UserDocu>deprecated -- use removeMenu</UserDocu>
</Documentation>
</Methode>
<Methode Name="ListMenus">
<Documentation>
<UserDocu>deprecated -- use listMenus</UserDocu>
</Documentation>
</Methode>
<Methode Name="AppendContextMenu">
<Documentation>
<UserDocu>deprecated -- use appendContextMenu</UserDocu>
</Documentation>
</Methode>
<Methode Name="RemoveContextMenu">
<Documentation>
<UserDocu>deprecated -- use removeContextMenu</UserDocu>
</Documentation>
</Methode>
<Methode Name="AppendToolbar">
<Documentation>
<UserDocu>deprecated -- use appendToolbar</UserDocu>
</Documentation>
</Methode>
<Methode Name="RemoveToolbar">
<Documentation>
<UserDocu>deprecated -- use removeToolbar</UserDocu>
</Documentation>
</Methode>
<Methode Name="ListToolbars">
<Documentation>
<UserDocu>deprecated -- use listToolbars</UserDocu>
</Documentation>
</Methode>
<Methode Name="AppendCommandbar">
<Documentation>
<UserDocu>deprecated -- use appendCommandBar</UserDocu>
</Documentation>
</Methode>
<Methode Name="RemoveCommandbar">
<Documentation>
<UserDocu>deprecated -- use removeCommandBar</UserDocu>
</Documentation>
</Methode>
<Methode Name="ListCommandbars">
<Documentation>
<UserDocu>deprecated -- use listCommandBars</UserDocu>
</Documentation>
</Methode>
<CustomAttributes />
</PythonExport>
</GenerateModel>

View File

@@ -1,95 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="BaseClassPy"
Name="SelectionObjectPy"
Twin="SelectionObject"
TwinPointer="SelectionObject"
Include="Gui/Selection/SelectionObject.h"
Namespace="Gui"
Delete="true"
FatherInclude="Base/BaseClassPy.h"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
<UserDocu>This class represents selections made by the user. It holds information about the object, document and sub-element of the selection.</UserDocu>
</Documentation>
<Methode Name="remove">
<Documentation>
<UserDocu>Remove this selection item from the selection.
remove() -> None
--
This object becomes invalid.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isObjectTypeOf">
<Documentation>
<UserDocu>Test for a certain father class.
isObjectTypeOf(type) -> Bool
</UserDocu>
</Documentation>
</Methode>
<Attribute Name="ObjectName" ReadOnly="true">
<Documentation>
<UserDocu>Name of the selected object</UserDocu>
</Documentation>
<Parameter Name="ObjectName" Type="String" />
</Attribute>
<Attribute Name="SubElementNames" ReadOnly="true">
<Documentation>
<UserDocu>Name of the selected sub-element if any</UserDocu>
</Documentation>
<Parameter Name="SubElementNames" Type="Tuple" />
</Attribute>
<Attribute Name="FullName" ReadOnly="true">
<Documentation>
<UserDocu>Name of the selected object</UserDocu>
</Documentation>
<Parameter Name="FullName" Type="String" />
</Attribute>
<Attribute Name="TypeName" ReadOnly="true">
<Documentation>
<UserDocu>Type name of the selected object</UserDocu>
</Documentation>
<Parameter Name="TypeName" Type="String" />
</Attribute>
<Attribute Name="DocumentName" ReadOnly="true">
<Documentation>
<UserDocu>Name of the document of the selected object</UserDocu>
</Documentation>
<Parameter Name="DocumentName" Type="String" />
</Attribute>
<Attribute Name="Document" ReadOnly="true">
<Documentation>
<UserDocu>Document of the selected object</UserDocu>
</Documentation>
<Parameter Name="Document" Type="Object" />
</Attribute>
<Attribute Name="Object" ReadOnly="true">
<Documentation>
<UserDocu>Selected object</UserDocu>
</Documentation>
<Parameter Name="Object" Type="Object" />
</Attribute>
<Attribute Name="SubObjects" ReadOnly="true">
<Documentation>
<UserDocu>Selected sub-element, if any</UserDocu>
</Documentation>
<Parameter Name="SubObjects" Type="Tuple" />
</Attribute>
<Attribute Name="PickedPoints" ReadOnly="true">
<Documentation>
<UserDocu>Picked points for selection</UserDocu>
</Documentation>
<Parameter Name="PickedPoints" Type="Tuple" />
</Attribute>
<Attribute Name="HasSubObjects" ReadOnly="true">
<Documentation>
<UserDocu>Selected sub-element, if any</UserDocu>
</Documentation>
<Parameter Name="HasSubObjects" Type="Boolean" />
</Attribute>
<CustomAttributes />
</PythonExport>
</GenerateModel>

View File

@@ -1,40 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ViewProviderPy"
Name="ViewProviderDocumentObjectPy"
Twin="ViewProviderDocumentObject"
TwinPointer="ViewProviderDocumentObject"
Include="Gui/ViewProviderDocumentObject.h"
Namespace="Gui"
FatherInclude="Gui/ViewProviderPy.h"
FatherNamespace="Gui">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the ViewProvider base class</UserDocu>
</Documentation>
<Methode Name="update">
<Documentation>
<UserDocu>Update the view representation of the object</UserDocu>
</Documentation>
</Methode>
<Attribute Name="Object">
<Documentation>
<UserDocu>Set/Get the associated data object</UserDocu>
</Documentation>
<Parameter Name="Object" Type="Object" />
</Attribute>
<Attribute Name="ForceUpdate">
<Documentation>
<UserDocu>Reference count to force update visual</UserDocu>
</Documentation>
<Parameter Name="ForceUpdate" Type="Boolean" />
</Attribute>
<Attribute Name="Document" ReadOnly="true">
<Documentation>
<UserDocu>Return the document the view provider is part of</UserDocu>
</Documentation>
<Parameter Name="Document" Type="Object" />
</Attribute>
</PythonExport>
</GenerateModel>

View File

@@ -1,28 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ExtensionPy"
Name="ViewProviderExtensionPy"
TwinPointer="ViewProviderExtension"
Twin="ViewProviderExtension"
Include="Gui/ViewProviderExtension.h"
Namespace="Gui"
FatherInclude="App/ExtensionPy.h"
FatherNamespace="App">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer[at]users.sourceforge.net" />
<UserDocu>Base class for all view provider extensions</UserDocu>
</Documentation>
<Methode Name="setIgnoreOverlayIcon">
<Documentation>
<UserDocu>Ignore the overlay icon of an extension</UserDocu>
</Documentation>
</Methode>
<Methode Name="ignoreOverlayIcon" Const="true">
<Documentation>
<UserDocu>Ignore the overlay icon of an extension</UserDocu>
</Documentation>
</Methode>
<CustomAttributes />
</PythonExport>
</GenerateModel>

View File

@@ -1,25 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ViewProviderDocumentObjectPy"
Name="ViewProviderGeometryObjectPy"
Twin="ViewProviderGeometryObject"
TwinPointer="ViewProviderGeometryObject"
Include="Gui/ViewProviderGeometryObject.h"
Namespace="Gui"
FatherInclude="Gui/ViewProviderDocumentObjectPy.h"
FatherNamespace="Gui">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the ViewProvider geometry class</UserDocu>
</Documentation>
<Methode Name="getUserDefinedMaterial" Static="true" NoArgs="true">
<Documentation>
<UserDocu>getUserDefinedMaterial() -> object
Get a material object with the user-defined colors.
</UserDocu>
</Documentation>
</Methode>
</PythonExport>
</GenerateModel>

View File

@@ -1,29 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ViewProviderDocumentObjectPy"
Name="ViewProviderLinkPy"
Twin="ViewProviderLink"
TwinPointer="ViewProviderLink"
Include="Gui/ViewProviderLink.h"
Namespace="Gui"
FatherInclude="Gui/ViewProviderDocumentObjectPy.h"
FatherNamespace="Gui">
<Documentation>
<Author Licence="LGPL" Name="Zheng, Lei" EMail="realthunder.dev@gmail.com" />
<UserDocu>This is the ViewProviderLink class</UserDocu>
</Documentation>
<Attribute Name="DraggingPlacement">
<Documentation>
<UserDocu>Get/set dragger placement during dragging</UserDocu>
</Documentation>
<Parameter Name="DraggingPlacement" Type="Object" />
</Attribute>
<Attribute Name="LinkView" ReadOnly="true">
<Documentation>
<UserDocu>Get the associated LinkView object</UserDocu>
</Documentation>
<Parameter Name="LinkView" Type="Object" />
</Attribute>
</PythonExport>
</GenerateModel>

View File

@@ -1,344 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ExtensionContainerPy"
Name="ViewProviderPy"
Twin="ViewProvider"
TwinPointer="ViewProvider"
Include="Gui/ViewProvider.h"
Namespace="Gui"
FatherInclude="App/ExtensionContainerPy.h"
FatherNamespace="App">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the ViewProvider base class</UserDocu>
</Documentation>
<Methode Name="addProperty">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeProperty">
<Documentation>
<UserDocu>removeProperty(name) -> bool
Remove a generic property.
Only user-defined properties can be removed, not built-in ones.
name : str
Property name.</UserDocu>
</Documentation>
</Methode>
<Methode Name="supportedProperties">
<Documentation>
<UserDocu>supportedProperties() -> list
A list of supported property types.</UserDocu>
</Documentation>
</Methode>
<Methode Name="show">
<Documentation>
<UserDocu>show() -> None
Show the object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="hide">
<Documentation>
<UserDocu>hide() -> None
Hide the object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="isVisible">
<Documentation>
<UserDocu>isVisible() -> bool
Check if the object is visible.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDragObject">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="dragObject">
<Documentation>
<UserDocu>dragObject(obj) -> None
Remove a child object by dropping.
obj : App.DocumentObject
Object to be dragged.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDropObject" Keyword="true">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="dropObject" Keyword="true">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="canDragAndDropObject">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="replaceObject">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="doubleClicked">
<Documentation>
<UserDocu>doubleClicked() -> bool
Trigger double clicking the corresponding tree item of this view object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="addDisplayMode">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="listDisplayModes">
<Documentation>
<UserDocu>listDisplayModes() -> list
Show a list of all display modes.</UserDocu>
</Documentation>
</Methode>
<Methode Name="toString">
<Documentation>
<UserDocu>toString() -> str
Return a string representation of the Inventor node.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setTransformation">
<Documentation>
<UserDocu>setTransformation(trans) -> None
Set a transformation on the Inventor node.
trans : Base.Placement, Base.Matrix</UserDocu>
</Documentation>
</Methode>
<Methode Name="claimChildren" Const="true">
<Documentation>
<UserDocu>claimChildren() -> list
Returns list of objects that are to be grouped in tree under this object.</UserDocu>
</Documentation>
</Methode>
<Methode Name="claimChildrenRecursive" Const="true">
<Documentation>
<UserDocu>claimChildrenRecursive() -> list
Returns list of objects that are to be grouped in tree under this object recursively.</UserDocu>
</Documentation>
</Methode>
<Methode Name="partialRender">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getElementColors">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setElementColors">
<Documentation>
<UserDocu>setElementColors(colors) -> None
Set element colors.
colors: dict
Color dictionary of the form {elementName:(r,g,b,a)}.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getElementPicked" Const="true">
<Documentation>
<UserDocu>getElementPicked(pickPoint) -> str
Return the picked subelement.
pickPoint : coin.SoPickedPoint</UserDocu>
</Documentation>
</Methode>
<Methode Name="getDetailPath" Const="true">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="signalChangeIcon" Const="true">
<Documentation>
<UserDocu>signalChangeIcon() -> None
Trigger icon changed signal.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getBoundingBox">
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Attribute Name="Annotation" ReadOnly="false">
<Documentation>
<UserDocu>A pivy Separator to add a custom scenegraph to this ViewProvider.</UserDocu>
</Documentation>
<Parameter Name="Annotation" Type="Object" />
</Attribute>
<Attribute Name="Icon" ReadOnly="true">
<Documentation>
<UserDocu>The icon of this ViewProvider.</UserDocu>
</Documentation>
<Parameter Name="Icon" Type="Object" />
</Attribute>
<Attribute Name="RootNode" ReadOnly="false">
<Documentation>
<UserDocu>A pivy Separator with the root of this ViewProvider.</UserDocu>
</Documentation>
<Parameter Name="RootNode" Type="Object" />
</Attribute>
<Attribute Name="SwitchNode" ReadOnly="false">
<Documentation>
<UserDocu>A pivy SoSwitch for the display mode switch of this ViewProvider.</UserDocu>
</Documentation>
<Parameter Name="SwitchNode" Type="Object" />
</Attribute>
<Attribute Name="DefaultMode" ReadOnly="false">
<Documentation>
<UserDocu>Get/Set the default display mode in turns of coin node index.</UserDocu>
</Documentation>
<Parameter Name="DefaultNode" Type="Long" />
</Attribute>
<Attribute Name="IV" ReadOnly="true">
<Documentation>
<UserDocu>Represents the whole ViewProvider as an Inventor string.</UserDocu>
</Documentation>
<Parameter Name="IV" Type="String" />
</Attribute>
<Attribute Name="CanRemoveChildrenFromRoot" ReadOnly="true">
<Documentation>
<UserDocu>Tells the tree view whether to remove the children item from root or not.</UserDocu>
</Documentation>
<Parameter Name="CanRemoveChildrenFromRoot" Type="Boolean" />
</Attribute>
<Attribute Name="LinkVisibility">
<Documentation>
<UserDocu>Get/set visibilities of all links to this view object.</UserDocu>
</Documentation>
<Parameter Name="LinkVisibility" Type="Boolean" />
</Attribute>
<Attribute Name="DropPrefix" ReadOnly="true" >
<Documentation>
<UserDocu>Subname referencing the sub-object for holding dropped object.</UserDocu>
</Documentation>
<Parameter Name="DropPrefix" Type="String" />
</Attribute>
</PythonExport>
</GenerateModel>

View File

@@ -1,53 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="BaseClassPy"
Name="WorkbenchPy"
Twin="Workbench"
TwinPointer="Workbench"
Include="Gui/Workbench.h"
Namespace="Gui"
FatherInclude="Base/BaseClassPy.h"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>This is the base class for workbenches</UserDocu>
</Documentation>
<Methode Name="name">
<Documentation>
<UserDocu>Return the workbench name</UserDocu>
</Documentation>
</Methode>
<Methode Name="activate">
<Documentation>
<UserDocu>Activate this workbench</UserDocu>
</Documentation>
</Methode>
<Methode Name="listToolbars">
<Documentation>
<UserDocu>Show a list of all toolbars</UserDocu>
</Documentation>
</Methode>
<Methode Name="getToolbarItems">
<Documentation>
<UserDocu>Show a dict of all toolbars and their commands</UserDocu>
</Documentation>
</Methode>
<Methode Name="listCommandbars">
<Documentation>
<UserDocu>Show a list of all command bars</UserDocu>
</Documentation>
</Methode>
<Methode Name="listMenus">
<Documentation>
<UserDocu>Show a list of all menus</UserDocu>
</Documentation>
</Methode>
<Methode Name="reloadActive" Static="true">
<Documentation>
<UserDocu>Reload the active workbench after changing menus or toolbars</UserDocu>
</Documentation>
</Methode>
<CustomAttributes />
</PythonExport>
</GenerateModel>

View File

@@ -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