diff --git a/src/Gui/ViewProviderPy.xml b/src/Gui/ViewProviderPy.xml index e624a74733..24261bb863 100644 --- a/src/Gui/ViewProviderPy.xml +++ b/src/Gui/ViewProviderPy.xml @@ -1,191 +1,206 @@ - - - - This is the ViewProvider base class - + + + + This is the ViewProvider base class + - - addProperty(string, string) -- Add a generic property. - The first argument specifies the type, the second the - name of the property. + Add a generic property. +addProperty(string, string) +-- +The first argument specifies the type, the second the name of the property. - - removeProperty(string) -- Remove a generic property. - Note, you can only remove user-defined properties, not built-in ones. + Remove a generic property. +removeProperty(string) +-- +Note, you can only remove user-defined properties, not built-in ones. - A list of supported property types + A list of supported property types + - - Show the object - - - - - Hide the object - - - - - Check if the object is visible - - - - - canDragObject(obj=None): check whether the child object can be removed by dragging - - - - - dragObject(obj): remove a child object by dropping - - - - - - canDropObject(obj=None,owner=None,subname=None) - check whether the child object can be added by dropping - - - - - - dropObject(obj,owner=None,subname=None): add a child object by dropping - - - - - + + Show the object + + + + + + Hide the object + + + + + + Check if the object is visible + + + + + + check whether the child object can be removed by dragging +canDragObject(obj=None) + + + + + + remove a child object by dropping +dragObject(obj) + + + + + + check whether the child object can be added by dropping +canDropObject(obj=None,owner=None,subname=None) + + + + + + add a child object by dropping +dropObject(obj,owner=None,subname=None) + + + + + Check whether the child object can be removed from other parent and added here by drag and drop canDragAndDropObject(obj) -Check whether the child object can be removed from other parent and added here by drag and drop - - - - - - -replaceObject(oldObj, newObj) -> Int: replace a child object - + + + + + + replace a child object +replaceObject(oldObj, newObj) -> Int +-- Returns 1 if succeeded, 0 if not found, -1 if not supported - - - + + + - Trigger double clicking the corresponding tree item of this view object + Trigger double clicking the corresponding tree item of this view object + - Add a new display mode to the view provider + Add a new display mode to the view provider + - - Show a list of all display modes - - - - - Return a string representation of the Inventor node - - - - - Set a transformation on the Inventor node - - + + Show a list of all display modes + + + + + + Return a string representation of the Inventor node + + + + + + Set a transformation on the Inventor node + + + - - Returns list of objects that are to be grouped in tree under this object. - - + + Returns list of objects that are to be grouped in tree under this object. + + + - - - partialRender(sub=None,clear=False): render only part of the object - - 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. - - - + + 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. + + + - - -getElementColors(elementName=None) -> dict(elementName:color) - - - - - - -setElementColors(colors): set element colors - -colors: color dictionary of type elementName:(r,g,b,a) - - - - - - getElementPicked(pickPoint): return the picked subelement - - - - - - getDetailPath(subname,path,append=True): return Coin detail and path of an subelement - - 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. - - - - - - Trigger icon changed signal - - - -getBoundingBox(subname=None, transform=True, view=None): obtain the bounding box of this view object - -* 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 +getElementColors(elementName=None) -> dict(elementName:color) - - - A pivy Separator to add a custom scenegraph to this ViewProvider - - - + + + +setElementColors(colors): set element colors +-- +colors: color dictionary of type elementName:(r,g,b,a) + + + + + + return the picked subelement +getElementPicked(pickPoint) + + + + + + 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. + + + + + + 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 + + + + + + A pivy Separator to add a custom scenegraph to this ViewProvider + + + The icon of this ViewProvider