diff --git a/src/Gui/ViewProviderPy.xml b/src/Gui/ViewProviderPy.xml index 72ad9c3f5d..58c7558417 100644 --- a/src/Gui/ViewProviderPy.xml +++ b/src/Gui/ViewProviderPy.xml @@ -15,213 +15,224 @@ - Add a generic property. -addProperty(string, string) --- -The first argument specifies the type, the second the name of the property. - + addProperty(type, name, group, doc, attr=0, ro=False, hd=False) -> ViewProvider\n +Add a generic property.\n +type : str\n Property type. +name : str\n Property name. Optional. +group : str\n Property group. Optional. +attr : int\n Property attributes. +ro : bool\n Read only property. +hd : bool\n Hidden property. - Remove a generic property. -removeProperty(string) --- -Note, you can only remove user-defined properties, not built-in ones. - + removeProperty(name) -> bool\n +Remove a generic property. +Only user-defined properties can be removed, not built-in ones.\n +name : str\n Property name. - A list of supported property types - + supportedProperties() -> list\n +A list of supported property types. - Show the object - + show() -> None\n +Show the object. - Hide the object - + show() -> None\n +Hide the object. - Check if the object is visible - + isVisible() -> bool\n +Check if the object is visible. - check whether the child object can be removed by dragging -canDragObject(obj=None) - + canDragObject(obj) -> bool\n +Check whether the child object can be removed by dragging. +If 'obj' is not given, check without filter by any particular object.\n +obj : App.DocumentObject\n Object to be dragged. Optional. - remove a child object by dropping -dragObject(obj) - + dragObject(obj) -> None\n +Remove a child object by dropping.\n +obj : App.DocumentObject\n Object to be dragged. - check whether the child object can be added by dropping -canDropObject(obj=None,owner=None,subname=None) - + canDropObject(obj, owner, subname, elem) -> bool\n +Check whether the child object can be added by dropping. +If 'obj' is not given, check without filter by any particular object.\n +obj : App.DocumentObject\n Object to be dropped. Optional. +owner : App.DocumentObject\n Parent object of the dropping object. Optional. +subname : str\n Subname reference to the dropping object. Optional. +elem : sequence of str\n Non-objects subelements selected when the object is + being dropped. Optional. - add a child object by dropping -dropObject(obj,owner=None,subname=None) + dropObject(obj, owner, subname, elem) -> str\n +Add a child object by dropping.\n +obj : App.DocumentObject\n Object to be dropped. +owner : App.DocumentObject\n Parent object of the dropping object. Optional. +subname : str\n Subname reference to the dropping object. Optional. +elem : sequence of str\n Non-objects subelements selected when the object is + being dropped. Optional. - Check whether the child object can be removed from other parent and added here by drag and drop -canDragAndDropObject(obj) - + canDragAndDropObject(obj) -> bool\n +Check whether the child object can be removed from +other parent and added here by drag and drop.\n +obj : App.DocumentObject\n Object to be dragged and dropped. - replace a child object -replaceObject(oldObj, newObj) -> Int --- -Returns 1 if succeeded, 0 if not found, -1 if not supported - + replaceObject(oldObj, newObj) -> int\n +Replace a child object. +Returns 1 if succeeded, 0 if not found, -1 if not supported.\n +oldObj : App.DocumentObject\n Old object. +newObj : App.DocumentObject\n New object. - Trigger double clicking the corresponding tree item of this view object - + doubleClicked() -> bool\n +Trigger double clicking the corresponding tree item of this view object. - Add a new display mode to the view provider - + addDisplayMode(obj, mode) -> None\n +Add a new display mode to the view provider.\n +obj : coin.SoNode\n Display mode. +mode : str\n Name of the display mode. - Show a list of all display modes - + listDisplayModes() -> list\n +Show a list of all display modes. - Return a string representation of the Inventor node - + toString() -> str\n +Return a string representation of the Inventor node. - Set a transformation on the Inventor node - + setTransformation(trans) -> None\n +Set a transformation on the Inventor node.\n +trans : Base.Placement, Base.Matrix - Returns list of objects that are to be grouped in tree under this object. - + claimChildren() -> list\n +Returns list of objects that are to be grouped in tree under this object. - render only part of the object -partialRender(sub=None,clear=False) --- -sub: string or list of string refer to the subelement. If it is None then reset the partial rendering. -clear: true to add, or false to remove the subelement(s) for rendering. - + partialRender(sub=None, clear=False) -> int\n +Render only part of the object.\n +sub: None, str, sequence of str\n Refer to the subelement. If it is None then reset the partial rendering. +clear: bool\n True to add, or False to remove the subelement(s) for rendering. - -getElementColors(elementName=None) -> dict(elementName:color) - + getElementColors(elementName) -> dict\n +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.\n +elementName : str\n Name of the element. Optional. - -setElementColors(colors): set element colors --- -colors: color dictionary of type elementName:(r,g,b,a) - + setElementColors(colors) -> None\n +Set element colors.\n +colors: dict\n Color dictionary of the form {elementName:(r,g,b,a)}. - return the picked subelement -getElementPicked(pickPoint) - + getElementPicked(pickPoint) -> str\n +Return the picked subelement.\n +pickPoint : coin.SoPickedPoint - return Coin detail and path of an subelement -getDetailPath(subname,path,append=True) --- -subelement: dot separated string reference to the sub element -pPath: output coin path leading to the returned element detail -append: If true, path will be first appended with the root node and the mode -switch node of this view provider. - + getDetailPath(subelement, path, append=True) -> coin.SoDetail or None\n +Return Coin detail and path of an subelement.\n +subname: str\n Dot separated string reference to the sub element. +pPath: coin.SoPath\n Output coin path leading to the returned element detail. +append: bool\n If True, path will be first appended with the root node and the mode + switch node of this view provider. - Trigger icon changed signal + signalChangeIcon() -> None\n +Trigger icon changed signal. - obtain the bounding box of this view object -getBoundingBox(subname=None, transform=True, view=None) --- -subname: the optional subname referring a sub-object -transform: whether to apply the transformation matrix of this view provider -view: the MDIView, default to active view - + getBoundingBox(subName, transform=True, view) -> Base.BoundBox\n +Obtain the bounding box of this view object.\n +subName : str\n Name referring a sub-object. Optional. +transform: bool\n Whether to apply the transformation matrix of this view provider. +view: View3DInventorPy\n Default to active view. Optional. - A pivy Separator to add a custom scenegraph to this ViewProvider + A pivy Separator to add a custom scenegraph to this ViewProvider. - The icon of this ViewProvider + The icon of this ViewProvider. - A pivy Separator with the root of this ViewProvider + A pivy Separator with the root of this ViewProvider. - A pivy SoSwitch for the display mode switch 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 + Get/Set the default display mode in turns of coin node index. @@ -233,19 +244,19 @@ view: the MDIView, default to active view - Tells the tree view whether to remove the children item from root or not + Tells the tree view whether to remove the children item from root or not. - Get/set visibilities of all links to this view object + Get/set visibilities of all links to this view object. - Subname referecing the sub-object for holding dropped object + Subname referecing the sub-object for holding dropped object.