Salome HOME
Join modifications from branch BR_DEBUG_3_2_0b1
[modules/visu.git] / doc / salome / gui / VISU / visugenidl_doc / interfaceVISU_1_1ViewManager.html
1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2 <html>
3 <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
6    <title>Main Page</title>
7 <link href="doxygen.css" rel="stylesheet" type="text/css">
8 </head>
9 <body>
10 &nbsp;
11 </body>
12 </html>
13 <!-- Generated by Doxygen 1.4.6 -->
14 <h1>VISU.ViewManager Interface Reference</h1><!-- doxytag: class="VISU::ViewManager" --><!-- doxytag: inherits="VISU::Base" -->Interface of the ViewManager.  
15 <a href="#_details">More...</a>
16 <p>
17 <code>import &quot;<a class="el" href="VISU__Gen_8idl-source.html">VISU_Gen.idl</a>&quot;;</code>
18 <p>
19 Inheritance diagram for VISU.ViewManager:<p><center><img src="interfaceVISU_1_1ViewManager__inherit__graph.jpg" border="0" alt="Inheritance graph"></center>
20 <table border="0" cellpadding="0" cellspacing="0">
21 <tr><td></td></tr>
22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
23 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceVISU_1_1View.html">View</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ViewManager.html#29565d6109c406e1788fe38f3cb0b86b">GetCurrentView</a> ()</td></tr>
24
25 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Getting an active View Frame.  <a href="#29565d6109c406e1788fe38f3cb0b86b"></a><br></td></tr>
26 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceVISU_1_1View3D.html">View3D</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ViewManager.html#ac015d77e09c9fc2bc2140e84f393df4">Create3DView</a> ()</td></tr>
27
28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creation of a 3d View.  <a href="#ac015d77e09c9fc2bc2140e84f393df4"></a><br></td></tr>
29 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceVISU_1_1TableView.html">TableView</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ViewManager.html#5cace760be5e742862542f282bf45e92">CreateTableView</a> (in <a class="el" href="interfaceVISU_1_1Table.html">Table</a> theTable)</td></tr>
30
31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creation of a <a class="el" href="interfaceVISU_1_1Table.html">Table</a> View.  <a href="#5cace760be5e742862542f282bf45e92"></a><br></td></tr>
32 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceVISU_1_1XYPlot.html">XYPlot</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ViewManager.html#38de690b7afce51ebe7c51e44324634d">CreateXYPlot</a> ()</td></tr>
33
34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creation of a 2D plot View.  <a href="#38de690b7afce51ebe7c51e44324634d"></a><br></td></tr>
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ViewManager.html#59c0b7dae7ded4c071bee9aad5c467a2">Destroy</a> (in <a class="el" href="interfaceVISU_1_1View.html">View</a> theView)</td></tr>
36
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">IdType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#5da28cc23f3657dd24a3b8598319c522">GetID</a> ()</td></tr>
38
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">VISUType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#6f62d77b0451737114b5a10bf23be21e">GetType</a> ()</td></tr>
40
41 </table>
42 <hr><a name="_details"></a><h2>Detailed Description</h2>
43 The <a class="el" href="interfaceVISU_1_1ViewManager.html">ViewManager</a> is necessary for work with view windows (creation and deletion). 
44 <p>
45 <hr><h2>Member Function Documentation</h2>
46 <a class="anchor" name="29565d6109c406e1788fe38f3cb0b86b"></a><!-- doxytag: member="VISU::ViewManager::GetCurrentView" ref="29565d6109c406e1788fe38f3cb0b86b" args="()" --><p>
47 <table class="mdTable" cellpadding="2" cellspacing="0">
48   <tr>
49     <td class="mdRow">
50       <table cellpadding="0" cellspacing="0" border="0">
51         <tr>
52           <td class="md" nowrap valign="top"><a class="el" href="interfaceVISU_1_1View.html">View</a> VISU.ViewManager.GetCurrentView           </td>
53           <td class="md" valign="top">(&nbsp;</td>
54           <td class="mdname1" valign="top" nowrap>          </td>
55           <td class="md" valign="top">&nbsp;)&nbsp;</td>
56           <td class="md" nowrap></td>
57         </tr>
58       </table>
59     </td>
60   </tr>
61 </table>
62 <table cellspacing="5" cellpadding="0" border="0">
63   <tr>
64     <td>
65       &nbsp;
66     </td>
67     <td>
68
69 <p>
70 Returns an object reference to the active View Frame. Type of the View must be checked. <dl compact><dt><b>Note:</b></dt><dd><br>
71 Returns nil if there are no views currently opened. </dd></dl>
72     </td>
73   </tr>
74 </table>
75 <a class="anchor" name="ac015d77e09c9fc2bc2140e84f393df4"></a><!-- doxytag: member="VISU::ViewManager::Create3DView" ref="ac015d77e09c9fc2bc2140e84f393df4" args="()" --><p>
76 <table class="mdTable" cellpadding="2" cellspacing="0">
77   <tr>
78     <td class="mdRow">
79       <table cellpadding="0" cellspacing="0" border="0">
80         <tr>
81           <td class="md" nowrap valign="top"><a class="el" href="interfaceVISU_1_1View3D.html">View3D</a> VISU.ViewManager.Create3DView           </td>
82           <td class="md" valign="top">(&nbsp;</td>
83           <td class="mdname1" valign="top" nowrap>          </td>
84           <td class="md" valign="top">&nbsp;)&nbsp;</td>
85           <td class="md" nowrap></td>
86         </tr>
87       </table>
88     </td>
89   </tr>
90 </table>
91 <table cellspacing="5" cellpadding="0" border="0">
92   <tr>
93     <td>
94       &nbsp;
95     </td>
96     <td>
97
98 <p>
99 Returns an object reference to the newly created 3D View.     </td>
100   </tr>
101 </table>
102 <a class="anchor" name="5cace760be5e742862542f282bf45e92"></a><!-- doxytag: member="VISU::ViewManager::CreateTableView" ref="5cace760be5e742862542f282bf45e92" args="(in Table theTable)" --><p>
103 <table class="mdTable" cellpadding="2" cellspacing="0">
104   <tr>
105     <td class="mdRow">
106       <table cellpadding="0" cellspacing="0" border="0">
107         <tr>
108           <td class="md" nowrap valign="top"><a class="el" href="interfaceVISU_1_1TableView.html">TableView</a> VISU.ViewManager.CreateTableView           </td>
109           <td class="md" valign="top">(&nbsp;</td>
110           <td class="md" nowrap valign="top">in <a class="el" href="interfaceVISU_1_1Table.html">Table</a>&nbsp;</td>
111           <td class="mdname1" valign="top" nowrap> <em>theTable</em>          </td>
112           <td class="md" valign="top">&nbsp;)&nbsp;</td>
113           <td class="md" nowrap></td>
114         </tr>
115       </table>
116     </td>
117   </tr>
118 </table>
119 <table cellspacing="5" cellpadding="0" border="0">
120   <tr>
121     <td>
122       &nbsp;
123     </td>
124     <td>
125
126 <p>
127 Returns an object reference to the newly created <a class="el" href="interfaceVISU_1_1Table.html">Table</a> View.     </td>
128   </tr>
129 </table>
130 <a class="anchor" name="38de690b7afce51ebe7c51e44324634d"></a><!-- doxytag: member="VISU::ViewManager::CreateXYPlot" ref="38de690b7afce51ebe7c51e44324634d" args="()" --><p>
131 <table class="mdTable" cellpadding="2" cellspacing="0">
132   <tr>
133     <td class="mdRow">
134       <table cellpadding="0" cellspacing="0" border="0">
135         <tr>
136           <td class="md" nowrap valign="top"><a class="el" href="interfaceVISU_1_1XYPlot.html">XYPlot</a> VISU.ViewManager.CreateXYPlot           </td>
137           <td class="md" valign="top">(&nbsp;</td>
138           <td class="mdname1" valign="top" nowrap>          </td>
139           <td class="md" valign="top">&nbsp;)&nbsp;</td>
140           <td class="md" nowrap></td>
141         </tr>
142       </table>
143     </td>
144   </tr>
145 </table>
146 <table cellspacing="5" cellpadding="0" border="0">
147   <tr>
148     <td>
149       &nbsp;
150     </td>
151     <td>
152
153 <p>
154 Returns an object reference to the newly created 2D plot View.     </td>
155   </tr>
156 </table>
157 <a class="anchor" name="59c0b7dae7ded4c071bee9aad5c467a2"></a><!-- doxytag: member="VISU::ViewManager::Destroy" ref="59c0b7dae7ded4c071bee9aad5c467a2" args="(in View theView)" --><p>
158 <table class="mdTable" cellpadding="2" cellspacing="0">
159   <tr>
160     <td class="mdRow">
161       <table cellpadding="0" cellspacing="0" border="0">
162         <tr>
163           <td class="md" nowrap valign="top">void VISU.ViewManager.Destroy           </td>
164           <td class="md" valign="top">(&nbsp;</td>
165           <td class="md" nowrap valign="top">in <a class="el" href="interfaceVISU_1_1View.html">View</a>&nbsp;</td>
166           <td class="mdname1" valign="top" nowrap> <em>theView</em>          </td>
167           <td class="md" valign="top">&nbsp;)&nbsp;</td>
168           <td class="md" nowrap></td>
169         </tr>
170       </table>
171     </td>
172   </tr>
173 </table>
174 <table cellspacing="5" cellpadding="0" border="0">
175   <tr>
176     <td>
177       &nbsp;
178     </td>
179     <td>
180
181 <p>
182 Deletes a definite view. <dl compact><dt><b>Parameters:</b></dt><dd>
183   <table border="0" cellspacing="2" cellpadding="0">
184     <tr><td valign="top"></td><td valign="top"><em>theView</em>&nbsp;</td><td>The view which should be deleted. </td></tr>
185   </table>
186 </dl>
187     </td>
188   </tr>
189 </table>
190 <a class="anchor" name="5da28cc23f3657dd24a3b8598319c522"></a><!-- doxytag: member="VISU::ViewManager::GetID" ref="5da28cc23f3657dd24a3b8598319c522" args="()" --><p>
191 <table class="mdTable" cellpadding="2" cellspacing="0">
192   <tr>
193     <td class="mdRow">
194       <table cellpadding="0" cellspacing="0" border="0">
195         <tr>
196           <td class="md" nowrap valign="top">IdType VISU.Base.GetID           </td>
197           <td class="md" valign="top">(&nbsp;</td>
198           <td class="mdname1" valign="top" nowrap>          </td>
199           <td class="md" valign="top">&nbsp;)&nbsp;</td>
200           <td class="md" nowrap><code> [inherited]</code></td>
201         </tr>
202       </table>
203     </td>
204   </tr>
205 </table>
206 <table cellspacing="5" cellpadding="0" border="0">
207   <tr>
208     <td>
209       &nbsp;
210     </td>
211     <td>
212
213 <p>
214 Returns ID of the object.     </td>
215   </tr>
216 </table>
217 <a class="anchor" name="6f62d77b0451737114b5a10bf23be21e"></a><!-- doxytag: member="VISU::ViewManager::GetType" ref="6f62d77b0451737114b5a10bf23be21e" args="()" --><p>
218 <table class="mdTable" cellpadding="2" cellspacing="0">
219   <tr>
220     <td class="mdRow">
221       <table cellpadding="0" cellspacing="0" border="0">
222         <tr>
223           <td class="md" nowrap valign="top">VISUType VISU.Base.GetType           </td>
224           <td class="md" valign="top">(&nbsp;</td>
225           <td class="mdname1" valign="top" nowrap>          </td>
226           <td class="md" valign="top">&nbsp;)&nbsp;</td>
227           <td class="md" nowrap><code> [inherited]</code></td>
228         </tr>
229       </table>
230     </td>
231   </tr>
232 </table>
233 <table cellspacing="5" cellpadding="0" border="0">
234   <tr>
235     <td>
236       &nbsp;
237     </td>
238     <td>
239
240 <p>
241 Returns the type of the presentable object     </td>
242   </tr>
243 </table>
244 </DIV>
245 </BODY>
246 </HTML>