diff --git a/src/App/ComplexGeoDataPy.xml b/src/App/ComplexGeoDataPy.xml index 00fb61f10b..04a963427d 100644 --- a/src/App/ComplexGeoDataPy.xml +++ b/src/App/ComplexGeoDataPy.xml @@ -66,17 +66,16 @@ - - setElementName(element,name=None,postfix=None,overwrite=False,sid=None), Set an element name + setElementName(element,name=None,postfix=None,overwrite=False,sid=None), Set an element name - element : the original element name, e.g. Edge1, Vertex2 - name : the new name for the element, None to remove the mapping - postfix : postfix of the name that will not be hashed - overwrite: if true, it will overwrite exiting name - sid : to hash the name any way you want, provide your own string id(s) in this parameter +element : the original element name, e.g. Edge1, Vertex2 +name : the new name for the element, None to remove the mapping +postfix : postfix of the name that will not be hashed +overwrite: if true, it will overwrite exiting name +sid : to hash the name any way you want, provide your own string id(s) in this parameter - An element can have multiple mapped names. However, a name can only be mapped - to one element +An element can have multiple mapped names. However, a name can only be mapped +to one element diff --git a/src/App/DocumentObjectPy.xml b/src/App/DocumentObjectPy.xml index ea63126b17..402aa5f2a2 100644 --- a/src/App/DocumentObjectPy.xml +++ b/src/App/DocumentObjectPy.xml @@ -24,7 +24,8 @@ removeProperty(string) -- Remove a generic property. - Note, you can only remove user-defined properties but not built-in ones. + +Note, you can only remove user-defined properties but not built-in ones. @@ -68,7 +69,7 @@ recompute(recursive=False): Recomputes this object - + Returns the status of the object as string. If the object is invalid its error description will be returned. @@ -77,7 +78,7 @@ If the object is valid but touched then 'Touched' will be returned, - + Returns True if the object is valid, False otherwise @@ -169,24 +170,28 @@ Return -1 if element visibility is not supported or element not found, 0 if invi Returns the group the object is in or None if it is not part of a group. - Note that an object can only be in a single group, hence only a single return - value. + +Note that an object can only be in a single group, hence only a single return value. + Returns the GeoFeatureGroup, and hence the local coordinate system, the object - is in or None if it is not part of a group. Note that an object can only be - in a single group, hence only a single return value. +is in or None if it is not part of a group. + +Note that an object can only be in a single group, hence only a single return value. + Returns the group the object is in or None if it is not part of a group. - Note that an object can only be in a single group, hence only a single return - value. - The parent can be a simple group as with getParentGroup() or a - GeoFeature group as with getParentGeoFeatureGroup(). + +Note that an object can only be in a single group, hence only a single return value. +The parent can be a simple group as with getParentGroup() or a GeoFeature group as +with getParentGeoFeatureGroup(). + @@ -235,7 +240,9 @@ Return tuple(obj,newElementName,oldElementName) - isAttachedToDocument(): return true if the object is part of a document, false otherwise + isAttachedToDocument() -> bool + +Return true if the object is part of a document, false otherwise. diff --git a/src/App/DocumentPy.xml b/src/App/DocumentPy.xml index 798994b3c8..6fb1d0659a 100644 --- a/src/App/DocumentPy.xml +++ b/src/App/DocumentPy.xml @@ -43,7 +43,7 @@ Checks if the document is saved - + Get the program version that a project file was created with @@ -60,11 +60,11 @@ For a temporary document it returns its transient directory. getUniqueObjectName(objName) -> objName - Return the same name, or the name made unique, for Example Box -> Box002 if there are conflicting name - already in the document. +Return the same name, or the name made unique, for Example Box -> Box002 if there are conflicting name +already in the document. - ObjName : str - Object name. +ObjName : str +Object name. @@ -127,7 +127,7 @@ viewType (String): override the view provider type directly, only effective when removeProperty(string) -- Remove a generic property. - Note, you can only remove user-defined properties but not built-in ones. +Note, you can only remove user-defined properties but not built-in ones. @@ -142,8 +142,8 @@ viewType (String): override the view provider type directly, only effective when copyObject(object, recursive=False, return_all=False) Copy an object or objects from another document to this document. -object: can either a single object or sequence of objects -recursive: if True, also recursively copies internal objects. +object: can either be a single object or sequence of objects +recursive: if True, also recursively copies internal objects return_all: if True, returns all copied objects, or else return only the copied object corresponding to the input objects. diff --git a/src/App/GroupExtensionPy.xml b/src/App/GroupExtensionPy.xml index 5860051f67..29eeca834a 100644 --- a/src/App/GroupExtensionPy.xml +++ b/src/App/GroupExtensionPy.xml @@ -56,9 +56,10 @@ hasObject(obj, recursive=false) - Checks if the group has a given object - @param obj the object to check for. - @param recursive if true check also if the obj is child of some sub group (default is false). + +Checks if the group has a given object +@param obj the object to check for. +@param recursive if true check also if the obj is child of some sub group (default is false). diff --git a/src/App/PropertyContainerPy.xml b/src/App/PropertyContainerPy.xml index 572e2ab145..806afe8420 100644 --- a/src/App/PropertyContainerPy.xml +++ b/src/App/PropertyContainerPy.xml @@ -22,7 +22,7 @@ Returns the value of a named property. Note that the returned property may not always belong to this container (e.g. from a linked object). name : str - Name of the property. + Name of the property. checkOwner : int 0: just return the property. 1: raise exception if not found or the property does not belong to this container. diff --git a/src/App/StringIDPy.xml b/src/App/StringIDPy.xml index acee95d628..3f0c3f01ae 100644 --- a/src/App/StringIDPy.xml +++ b/src/App/StringIDPy.xml @@ -59,6 +59,6 @@ private: friend class StringID; int _index = 0; - +