FreeCAD

1
<?xml version="1.0" encoding="UTF-8"?>
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
3
  <PythonExport
4
    Father="PersistencePy"
5
    Name="DocumentPy"
6
    Twin="Document"
7
    TwinPointer="Document"
8
    Include="Gui/Document.h"
9
    Namespace="Gui"
10
    FatherInclude="Base/PersistencePy.h"
11
    FatherNamespace="Base">
12
    <Documentation>
13
      <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
14
      <UserDocu>This is a Document class</UserDocu>
15
    </Documentation>
16
    <Methode Name="show">
17
      <Documentation>
18
        <UserDocu>show(objName) -> None
19

20
Show an object.
21

22
objName : str
23
    Name of the `Gui.ViewProvider` to show.</UserDocu>
24
      </Documentation>
25
    </Methode>
26
    <Methode Name="hide">
27
      <Documentation>
28
        <UserDocu>hide(objName) -> None
29

30
Hide an object.
31

32
objName : str
33
    Name of the `Gui.ViewProvider` to hide.</UserDocu>
34
      </Documentation>
35
    </Methode>
36
    <Methode Name="setPos">
37
      <Documentation>
38
        <UserDocu>setPos(objName, matrix) -> None
39

40
Set the position of an object.
41

42
objName : str
43
    Name of the `Gui.ViewProvider`.
44

45
matrix : Base.Matrix
46
    Transformation to apply on the object.</UserDocu>
47
      </Documentation>
48
    </Methode>
49
    <Methode Name="setEdit">
50
      <Documentation>
51
        <UserDocu>setEdit(obj, mod=0, subName) -> bool
52

53
Set an object in edit mode.
54

55
obj : str, App.DocumentObject, Gui.ViewPrivider
56
    Object to set in edit mode.
57
mod : int
58
    Edit mode.
59
subName : str
60
    Subelement name. Optional.</UserDocu>
61
      </Documentation>
62
    </Methode>
63
    <Methode Name="getInEdit">
64
      <Documentation>
65
        <UserDocu>getInEdit() -> Gui.ViewProviderDocumentObject or None
66

67
Returns the current object in edit mode or None if there is no such object.</UserDocu>
68
      </Documentation>
69
    </Methode>
70
    <Methode Name="resetEdit">
71
      <Documentation>
72
        <UserDocu>resetEdit() -> None
73

74
End the current editing.</UserDocu>
75
      </Documentation>
76
    </Methode>
77
    <Methode Name="addAnnotation">
78
      <Documentation>
79
        <UserDocu>addAnnotation(annoName, fileName, modName) -> None
80

81
Add an Inventor object from a file.
82

83
annoName : str
84
    Annotation name.
85
fileName : str
86
    File name.
87
modName : str
88
    Display mode name. Optional.</UserDocu>
89
      </Documentation>
90
    </Methode>
91
    <Methode Name="update">
92
      <Documentation>
93
        <UserDocu>update() -> None
94

95
Update the view representations of all objects.</UserDocu>
96
      </Documentation>
97
    </Methode>
98
    <Methode Name="getObject">
99
      <Documentation>
100
        <UserDocu>getObject(objName) -> object or None
101

102
Return the object with the given name. If no one exists, return None.
103

104
ObjName : str
105
    Object name.</UserDocu>
106
      </Documentation>
107
    </Methode>
108
    <Methode Name="activeObject">
109
      <Documentation>
110
        <UserDocu>activeObject() -> object or None
111

112
The active object of the document. Deprecated, use ActiveObject.</UserDocu>
113
      </Documentation>
114
    </Methode>
115
    <Methode Name="activeView">
116
      <Documentation>
117
        <UserDocu>activeView() -> object or None
118

119
The active view of the document. Deprecated, use ActiveView.</UserDocu>
120
      </Documentation>
121
    </Methode>
122
    <Methode Name="mdiViewsOfType" Const="true">
123
      <Documentation>
124
      <UserDocu>mdiViewsOfType(type) -> list of MDIView
125

126
Return a list of mdi views of a given type.
127

128
type : str
129
    Type name.</UserDocu>
130
      </Documentation>
131
    </Methode>
132
    <Methode Name="save">
133
      <Documentation>
134
        <UserDocu>save() -> bool
135

136
Attempts to save the document</UserDocu>
137
      </Documentation>
138
    </Methode>
139
    <Methode Name="saveAs">
140
      <Documentation>
141
        <UserDocu>saveAs() -> bool
142

143
Attempts to save the document under a new name</UserDocu>
144
      </Documentation>
145
    </Methode>
146
    <Methode Name="sendMsgToViews">
147
      <Documentation>
148
      <UserDocu>sendMsgToViews(msg) -> None
149

150
Send a message to all views of the document.
151

152
msg : str</UserDocu>
153
      </Documentation>
154
    </Methode>
155
    <Methode Name="mergeProject">
156
      <Documentation>
157
        <UserDocu>mergeProject(fileName) -> None
158

159
Merges this document with another project file.
160

161
fileName : str
162
    File name.</UserDocu>
163
      </Documentation>
164
    </Methode>
165
    <Methode Name="toggleTreeItem">
166
      <Documentation>
167
        <UserDocu>toggleTreeItem(obj, mod=0, subName) -> None
168

169
Change TreeItem of a document object.
170

171
obj : App.DocumentObject
172
mod : int
173
    Item mode.
174
    0: Toggle, 1: Collapse, 2: Expand, 3: Expand path.
175
subName : str
176
    Subelement name. Optional.</UserDocu>
177
      </Documentation>
178
    </Methode>
179
    <Methode Name="scrollToTreeItem">
180
      <Documentation>
181
        <UserDocu>scrollToTreeItem(obj) -> None
182

183
Scroll the tree view to the item of a view object.
184

185
obj : Gui.ViewProviderDocumentObject</UserDocu>
186
      </Documentation>
187
    </Methode>
188
    <Methode Name="toggleInSceneGraph">
189
      <Documentation>
190
        <UserDocu>toggleInSceneGraph(obj) -> None
191

192
Add or remove view object from scene graph of all views depending
193
on its canAddToSceneGraph().
194

195
obj : Gui.ViewProvider</UserDocu>
196
      </Documentation>
197
    </Methode>
198
    <Attribute Name="ActiveObject" ReadOnly="false">
199
      <Documentation>
200
        <UserDocu>The active object of the document.</UserDocu>
201
      </Documentation>
202
      <Parameter Name="ActiveObject" Type="Object" />
203
    </Attribute>
204
    <Attribute Name="ActiveView" ReadOnly="false">
205
      <Documentation>
206
        <UserDocu>The active view of the document.</UserDocu>
207
      </Documentation>
208
      <Parameter Name="ActiveView" Type="Object" />
209
    </Attribute>
210
    <Attribute Name="EditingTransform">
211
      <Documentation>
212
        <UserDocu>The editing transformation matrix.</UserDocu>
213
      </Documentation>
214
      <Parameter Name="EditingTransform" Type="Object" />
215
    </Attribute>
216
    <Attribute Name="InEditInfo">
217
      <Documentation>
218
        <UserDocu>A tuple(obj,subname,subElement,editMode) of editing object reference, or None if no object is in edit.</UserDocu>
219
      </Documentation>
220
    <Parameter Name="InEditInfo" Type="Object" />
221
    </Attribute>
222
    <Attribute Name="EditMode" ReadOnly="true">
223
      <Documentation>
224
        <UserDocu>Current edit mode. Only meaningful when there is a current object in edit.</UserDocu>
225
      </Documentation>
226
    <Parameter Name="EditMode" Type="Int" />
227
    </Attribute>
228
    <Attribute Name="Document" ReadOnly="true">
229
      <Documentation>
230
        <UserDocu>The related App document to this Gui document.</UserDocu>
231
      </Documentation>
232
      <Parameter Name="Document" Type="Object" />
233
    </Attribute>
234
    <Attribute Name="Transacting" ReadOnly="true">
235
      <Documentation>
236
        <UserDocu>Indicate whether the document is undoing/redoing.</UserDocu>
237
      </Documentation>
238
      <Parameter Name="Transacting" Type="Boolean" />
239
    </Attribute>
240
    <Attribute Name="Modified">
241
      <Documentation>
242
        <UserDocu>Returns True if the document is marked as modified, and False otherwise.</UserDocu>
243
      </Documentation>
244
      <Parameter Name="Modified" Type="Boolean" />
245
    </Attribute>
246
    <Attribute Name="TreeRootObjects" ReadOnly="true">
247
      <Documentation>
248
        <UserDocu>The list of tree root objects.</UserDocu>
249
      </Documentation>
250
      <Parameter Name="TreeRootObjects" Type="List" />
251
    </Attribute>
252
  </PythonExport>
253
</GenerateModel>
254