131 lines
5.4 KiB
XML
131 lines
5.4 KiB
XML
<?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="PropertyContainerPy"
|
|
TwinPointer="PropertyContainer"
|
|
Twin="PropertyContainer"
|
|
Include="App/PropertyContainer.h"
|
|
Namespace="App"
|
|
FatherInclude="Base/PersistencePy.h"
|
|
FatherNamespace="Base"
|
|
DisableNotify="true">
|
|
<Documentation>
|
|
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
|
|
<UserDocu>This is a Persistence class</UserDocu>
|
|
</Documentation>
|
|
<Methode Name="getPropertyByName">
|
|
<Documentation>
|
|
<UserDocu>
|
|
getPropertyByName(name,checkOwner=0)
|
|
|
|
Return 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: name of the property
|
|
* checkOwner: 0: just return the property
|
|
1: raise exception if not found or the property
|
|
does not belong to this container
|
|
2: return a tuple(owner,property_value)
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getPropertyTouchList">
|
|
<Documentation>
|
|
<UserDocu>Return a list of index of touched values for list type properties.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getTypeOfProperty">
|
|
<Documentation>
|
|
<UserDocu>Return the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination. </UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getTypeIdOfProperty">
|
|
<Documentation>
|
|
<UserDocu>Returns the C++ class name of a named property.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="setEditorMode">
|
|
<Documentation>
|
|
<UserDocu>Set the behaviour of the property in the property editor.
|
|
0 - default behaviour
|
|
1 - item is ready-only
|
|
2 - item is hidden
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getEditorMode">
|
|
<Documentation>
|
|
<UserDocu>Get the behaviour of the property in the property editor.
|
|
It returns a list of strings with the current mode. If the list is empty there are no special restrictions.
|
|
If the list contains 'ReadOnly' then the item appears in the property editor but is disabled.
|
|
If the list contains 'Hidden' then the item even doesn't appear in the property editor.
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getGroupOfProperty">
|
|
<Documentation>
|
|
<UserDocu>Return the name of the group which the property belongs to in this class. The properties sorted in different named groups for convenience.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="setPropertyStatus">
|
|
<Documentation>
|
|
<UserDocu>
|
|
setPropertyStatus(name,val): Set property status
|
|
|
|
name(String): property name
|
|
|
|
val(String|Int|[String|Int...]): text or integer value, or list/tuple of
|
|
values. Call getPropertyStatus() to get a list of supported text value.
|
|
If the text start with '-' or the integer value is negative, then the
|
|
status is cleared.
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getPropertyStatus">
|
|
<Documentation>
|
|
<UserDocu>
|
|
getPropertyStatus(name=''): Get property status.
|
|
|
|
name(String): property name. If name is empty, return a list of supported
|
|
text names of the status.
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getDocumentationOfProperty">
|
|
<Documentation>
|
|
<UserDocu>Return the documentation string of the property of this class.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getEnumerationsOfProperty">
|
|
<Documentation>
|
|
<UserDocu>Return all enumeration strings of the property of this class or None if not a PropertyEnumeration.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="dumpPropertyContent" Keyword="true" Const="true">
|
|
<Documentation>
|
|
<UserDocu>Dumps the content of the property, both the XML representation as well as the additional datafiles
|
|
required, into a byte representation. It will be returned as byte array.
|
|
dumpPropertyContent(propertyname) -- returns a byte array with full content
|
|
dumpPropertyContent(propertyname, [Compression=1-9]) -- Sets the data compression from 0 (no) to 9 (max)
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="restorePropertyContent">
|
|
<Documentation>
|
|
<UserDocu>Restore the content of given property from a byte representation as stored by \"dumpContent\".
|
|
It could be restored from any python object implementing the buffer protocol.
|
|
restorePropertyContent(propertyname, buffer) -- restores from the given byte array
|
|
</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Attribute Name="PropertiesList" ReadOnly="true">
|
|
<Documentation>
|
|
<UserDocu>A list of all property names</UserDocu>
|
|
</Documentation>
|
|
<Parameter Name="PropertiesList" Type="List"/>
|
|
</Attribute>
|
|
<CustomAttributes />
|
|
</PythonExport>
|
|
</GenerateModel>
|