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

App: Clean up XML bindings.

Browse Source
This commit is contained in:
tritao
2025-02-12 01:24:36 +00:00
parent 516595fbce
commit 9e08039ab6
6 changed files with 41 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/App/ComplexGeoDataPy.xml
View File

@@ -66,17 +66,16 @@
</Methode>
<Methode Name="setElementName" Keyword="true">
<Documentation>
<UserDocu>
setElementName(element,name=None,postfix=None,overwrite=False,sid=None), Set an element name
<UserDocu>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
</UserDocu>
</Documentation>
</Methode>

31
src/App/DocumentObjectPy.xml
View File

@@ -24,7 +24,8 @@
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
@@ -68,7 +69,7 @@
<UserDocu>recompute(recursive=False): Recomputes this object</UserDocu>
</Documentation>
</Methode>
<Methode Name="getStatusString" const="True">
<Methode Name="getStatusString" Const="true">
<Documentation>
<UserDocu>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 &apos;Touched&apos; will be returned,
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isValid" const="True">
<Methode Name="isValid" Const="true">
<Documentation>
<UserDocu>Returns True if the object is valid, False otherwise</UserDocu>
</Documentation>
@@ -169,24 +170,28 @@ Return -1 if element visibility is not supported or element not found, 0 if invi
<Methode Name="getParentGroup">
<Documentation>
<UserDocu>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.</UserDocu>
Note that an object can only be in a single group, hence only a single return value.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getParentGeoFeatureGroup">
<Documentation>
<UserDocu>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.</UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getParent">
<Documentation>
<UserDocu>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().</UserDocu>
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().
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getPathsByOutList">
@@ -235,7 +240,9 @@ Return tuple(obj,newElementName,oldElementName)
<Methode Name="isAttachedToDocument" Const="true">
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>

16
src/App/DocumentPy.xml
View File

@@ -43,7 +43,7 @@
<UserDocu>Checks if the document is saved</UserDocu>
</Documentation>
</Methode>
<Methode Name="getProgramVersion">
<Methode Name="getProgramVersion" Type="String">
<Documentation>
<UserDocu>Get the program version that a project file was created with</UserDocu>
</Documentation>
@@ -60,11 +60,11 @@ For a temporary document it returns its transient directory.
<Documentation>
<UserDocu>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.
</UserDocu>
</Documentation>
</Methode>
@@ -127,7 +127,7 @@ viewType (String): override the view provider type directly, only effective when
<Documentation>
<UserDocu>
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.
</UserDocu>
</Documentation>
</Methode>
@@ -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.
</UserDocu>

7
src/App/GroupExtensionPy.xml
View File

@@ -56,9 +56,10 @@
<Methode Name="hasObject">
<Documentation>
<UserDocu>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).
</UserDocu>
</Documentation>
</Methode>

2
src/App/PropertyContainerPy.xml
View File

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

2
src/App/StringIDPy.xml
View File

@@ -59,6 +59,6 @@
<ClassDeclarations>private:
friend class StringID;
int _index = 0;
</ClassDeclarations>
</ClassDeclarations>
</PythonExport>
</GenerateModel>