kindred/create
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Documents CommandPy.xml and DocumentPy.xml

Browse Source
This commit is contained in:
flachyjoe
2021-04-17 22:46:07 +02:00
committed by wwmayer
parent 7e48441687
commit 6ee63c41ce
2 changed files with 147 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
src/Gui/CommandPy.xml
View File

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
<PythonExport
Father="PyObjectBase"
Name="CommandPy"
Name="CommandPy"
Twin="Command"
TwinPointer="Command"
Include="Gui/Command.h"
@@ -15,88 +15,82 @@
</Documentation>
<Methode Name="get" Static='true'>
<Documentation>
<UserDocu>get(string) -> Command
Get a given command by name or None if it doesn't exist.
<UserDocu>Get a given command by name or None if it doesn't exist.
get(string) -> Command
</UserDocu>
</Documentation>
</Methode>
<Methode Name="update" Static='true'>
<Documentation>
<UserDocu>update() -> None
Update active status of all commands.
<UserDocu>Update active status of all commands.
update() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="listAll" Static='true'>
<Documentation>
<UserDocu>listAll() -> list of strings
Returns the name of all commands.
<UserDocu>Returns the name of all commands.
listAll() -> list of strings
</UserDocu>
</Documentation>
</Methode>
<Methode Name="listByShortcut" Static='true'>
<Documentation>
<UserDocu>listByShortcut(string, bool bUseRegExp=False) -> list of strings
Returns a list of all commands, filtered by shortcut.
<UserDocu>Returns a list of all commands, filtered by shortcut.
listByShortcut(string, bool bUseRegExp=False) -> list of strings
--
Shortcuts are converted to uppercase and spaces removed prior to comparison.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="run">
<Documentation>
<UserDocu>run() -> None
Runs the given command.
<UserDocu>Runs the given command.
run() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isActive" Const="true">
<Documentation>
<UserDocu>isActive() -> bool
Returns True if the command is active, False otherwise.
<UserDocu>Returns True if the command is active, False otherwise.
isActive() -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getShortcut">
<Documentation>
<UserDocu>getShortcut() -> string
Returns string representing shortcut key accelerator for command.
<UserDocu>Returns string representing shortcut key accelerator for command.
getShortcut() -> string
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setShortcut">
<Documentation>
<UserDocu>setShortcut(string) -> bool
Sets shortcut for given command, returns bool True for success.
<UserDocu>Sets shortcut for given command, returns bool True for success.
setShortcut(string) -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="resetShortcut">
<Documentation>
<UserDocu>resetShortcut() -> bool
Resets shortcut for given command back to the default, returns bool True for success.
<UserDocu>Resets shortcut for given command back to the default, returns bool True for success.
resetShortcut() -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getInfo">
<Documentation>
<UserDocu>getInfo() -> list of strings
<UserDocu>Return information about this command.
getInfo() -> list of strings
--
Usage: menuText, tooltipText, whatsThisText, statustipText, pixmapText, shortcutText.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getAction">
<Documentation>
<UserDocu>getAction() -> list of QAction</UserDocu>
<UserDocu>Return the associated QAction object.
getAction() -> list of QAction</UserDocu>
</Documentation>
</Methode>
</PythonExport>

224
src/Gui/DocumentPy.xml
View File

@@ -1,13 +1,13 @@
<?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"
<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" />
@@ -15,148 +15,166 @@
</Documentation>
<Methode Name="show">
<Documentation>
<UserDocu>Show the object</UserDocu>
<UserDocu>Show the object
show() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="hide">
<Documentation>
<UserDocu>Hide the object</UserDocu>
<UserDocu>Hide the object
hide() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setPos">
<Documentation>
<UserDocu>Set the position</UserDocu>
<UserDocu>Set the position
setPos(matrix) -> None</UserDocu>
</Documentation>
</Methode>
<Methode Name="setEdit">
<Documentation>
<UserDocu>
setEdit([String:Name|ViewProvider|DocumentObject]|,mod,subname=None)
Set the given object in edit mode.
</UserDocu>
<UserDocu>Set the given object in edit mode.
setEdit([String:Name|ViewProvider|DocumentObject]|,mod,subname=None) -> Bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getInEdit">
<Documentation>
<UserDocu>
getInEdit()
Returns the current object in edit mode or None if there is no such object
</UserDocu>
<UserDocu>Returns the current object in edit mode or None if there is no such object
getInEdit() -> Object or None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="resetEdit">
<Documentation>
<UserDocu>
Reset (end) the current editing.
<UserDocu>Reset (end) the current editing.
resetEdit() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="addAnnotation">
<Documentation>
<UserDocu>Add an Inventor object</UserDocu>
<UserDocu>Add an Inventor object
addAnnotation(AnnoName,FileName,[ModName]) -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="update">
<Documentation>
<UserDocu>Update the view representations of all objects</UserDocu>
<UserDocu>Update the view representations of all objects
update() -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getObject">
<Documentation>
<UserDocu>Return the object with the given name</UserDocu>
<UserDocu>Return the object with the given name
getObject(Name) -> Object or None</UserDocu>
</Documentation>
</Methode>
<Methode Name="activeObject">
<Documentation>
<UserDocu>deprecated -- use ActiveObject</UserDocu>
</Documentation>
</Methode>
<Methode Name="activeView">
<Methode Name="activeObject">
<Documentation>
<UserDocu>deprecated -- use ActiveObject</UserDocu>
</Documentation>
</Methode>
<Methode Name="activeView">
<Documentation>
<UserDocu>deprecated -- use ActiveView</UserDocu>
</Documentation>
</Methode>
<Methode Name="mdiViewsOfType" Const="true">
<Documentation>
<UserDocu>Return a list if mdi views of a given type</UserDocu>
</Documentation>
</Methode>
<Methode Name="sendMsgToViews">
<Documentation>
<UserDocu>Send a message to all views of the document</UserDocu>
</Documentation>
</Methode>
<Methode Name="mergeProject">
<Documentation>
<UserDocu>Merges this document with another project file</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleTreeItem">
<Documentation>
<UserDocu>toggleTreeItem(DocObject,int=0) - change TreeItem of a document object 0:Toggle,1:Collaps,2:Expand</UserDocu>
</Documentation>
</Methode>
<Methode Name="scrollToTreeItem">
<Documentation>
<UserDocu>scrollToTreeItem(ViewObject) - scroll the tree view to the item of a view object</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleInSceneGraph">
<Documentation>
<UserDocu>
toggleInSceneGraph(ViewObject)
Add or remove view object from scene graph of all views depending on its canAddToSceneGraph()
</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>
<Methode Name="mdiViewsOfType" Const="true">
<Documentation>
<UserDocu>Return a list if mdi views of a given type
mdiViewsOfType(type) -> list of MDIView
</UserDocu>
</Documentation>
</Methode>
<Methode Name="sendMsgToViews">
<Documentation>
<UserDocu>Send a message to all views of the document
sendMsgToViews(msg) -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="mergeProject">
<Documentation>
<UserDocu>Merges this document with another project file
mergeProject(filename) -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleTreeItem">
<Documentation>
<UserDocu>Change TreeItem of a document object.
toggleTreeItem(DocObject,[flag=0]) -> None
--
flag can be 0:Toggle, 1:Collaps, 2:Expand
</UserDocu>
</Documentation>
</Methode>
<Methode Name="scrollToTreeItem">
<Documentation>
<UserDocu>scroll the tree view to the item of a view object
scrollToTreeItem(ViewObject) -> None
</UserDocu>
</Documentation>
</Methode>
<Methode Name="toggleInSceneGraph">
<Documentation>
<UserDocu>Add or remove view object from scene graph of all views depending on its canAddToSceneGraph()
toggleInSceneGraph(ViewObject) -> None
</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" />
<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="Int" />
<Parameter Name="EditMode" Type="Int" />
</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" ReadOnly="true">
<Documentation>
<UserDocu>Returns True if the document is marked as modified, and False otherwise</UserDocu>
</Documentation>
<Parameter Name="Modified" Type="Boolean" />
</Attribute>
</PythonExport>
<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" ReadOnly="true">
<Documentation>
<UserDocu>Returns True if the document is marked as modified, and False otherwise</UserDocu>
</Documentation>
<Parameter Name="Modified" Type="Boolean" />
</Attribute>
</PythonExport>
</GenerateModel>