source: trunk/gui/idl/nomwindow.idl@ 241

Last change on this file since 241 was 226, checked in by cinc, 19 years ago

Added doxygen documentation for NOMWindow.

File size: 3.1 KB
Line 
1/* ***** BEGIN LICENSE BLOCK *****
2* Version: CDDL 1.0/LGPL 2.1
3*
4* The contents of this file are subject to the COMMON DEVELOPMENT AND
5* DISTRIBUTION LICENSE (CDDL) Version 1.0 (the "License"); you may not use
6* this file except in compliance with the License. You may obtain a copy of
7* the License at http://www.sun.com/cddl/
8*
9* Software distributed under the License is distributed on an "AS IS" basis,
10* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11* for the specific language governing rights and limitations under the
12* License.
13*
14* The Original Code is "NOM" Netlabs Object Model
15*
16* The Initial Developer of the Original Code is
17* netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
18* Portions created by the Initial Developer are Copyright (C) 2005-2006
19* the Initial Developer. All Rights Reserved.
20*
21* Contributor(s):
22*
23* Alternatively, the contents of this file may be used under the terms of
24* the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
25* case the provisions of the LGPL are applicable instead of those above. If
26* you wish to allow use of your version of this file only under the terms of
27* the LGPL, and not to allow others to use your version of this file under
28* the terms of the CDDL, indicate your decision by deleting the provisions
29* above and replace them with the notice and other provisions required by the
30* LGPL. If you do not delete the provisions above, a recipient may use your
31* version of this file under the terms of any one of the CDDL or the LGPL.
32*
33* ***** END LICENSE BLOCK ***** */
34
35#ifndef NOMWINDOW_IDL_INCLUDED
36#define NOMWINDOW_IDL_INCLUDED
37
38#include "nomobj.idl"
39
40#ifndef PGtkWidget_defined
41#define PGtkWidget_defined
42/* This should be moved in a header file */
43native PGtkWidget;
44#endif
45
46NOMCLASSNAME(NOMWindow);
47
48/** \class NOMWindow
49 This class represents a toplevel window.
50*/
51interface NOMWindow : NOMObject
52{
53 /**
54 Current class version is 1.0
55 */
56 NOMCLASSVERSION(1, 0);
57
58 /**
59 Query the window handle from the instance data. This is the handle of the toplevel window,
60 not a child window handle.
61
62 \return Toplevel window handle.
63
64 \sa setWindowHandle.
65 */
66 PGtkWidget queryWindowHandle();
67
68 /**
69 Saves the toplevel window handle in the instance data.
70
71 \remark
72 When overriding don't save any child window handle using this method. It's only
73 for toplevel windows.
74
75 \param pgWidget Handle of a toplevel GTK window.
76
77 \sa queryWindowHandle()
78 */
79 void setWindowHandle(in PGtkWidget pgWidget);
80
81 /**
82 Shows a hidden window.
83
84 \sa present()
85 */
86 void show();
87
88 /**
89 Hides the window.
90
91 \sa show()
92 */
93 void hide();
94
95 /**
96 Brings a window to the front if covered by other windows. If the window
97 is iconofied it will be deiconofied and brought to the foreground.
98
99 \sa show()
100 */
101 void present();
102
103 /**
104 Private variable holding the GtkWidget pointer.
105 */
106 NOMINSTANCEVAR(PGtkWidget _pgWindowHandle);
107};
108
109#endif /* NOMWINDOW_IDL_INCLUDED */
110
111
112
113
114
115
Note: See TracBrowser for help on using the repository browser.