source: trunk/desktop/idl/m_wpobject.idl

Last change on this file was 248, checked in by cinc, 19 years ago

Added doxygen tags. Renamed methods.
File size: 3.2 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-2007
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/** \file
35 Class definition file for M_WPObject class.
36*/
37
38#ifndef M_WPOBJECT_IDL_INCLUDED
39#define M_WPOBJECT_IDL_INCLUDED
40
41#include <nomcls.idl>
42
43NOMCLASSNAME(M_WPObject);
44
45#include "wpnativetypes.idl"
46#include "nomstring.idl"
47
48/** \interface M_WPObject
49
50 This class is the metaclass for the WPObject class.
51 */
52interface M_WPObject : NOMClass
53{
54 NOMCLASSVERSION(1, 0);
55
56 gpointer wpclsQueryIcon();
57 boolean wpclsSetIcon(in gpointer pNewIcon);
58
59 /**
60 This method returns the class title for classes for which this is the metaclass.
61 */
62 string wpclsQueryTitle();
63
64 /**
65 Method to be overriden by metaclasses when they need to do some setup.
66
67 \remark Desktop metaclasses should override this method instead of nomInit().
68
69 \par How to override:
70 This method should be overriden by classes which need initialization. The parent
71 must be called first.
72
73 \sa wpclsUnInitData()
74 */
75 void wpclsInitData();
76
77 /**
78 Method to be overriden by classes when they need to do some unititialization work.
79
80 \remark Desktop metaclasses should override this method instead of nomUnInit().
81
82 \par How to override
83 This method should be overriden by classes which need uninitialization. The parent must
84 be called last.
85
86 \sa wpclsInitData()
87 */
88 void wpclsUnInitData();
89
90 /* Methods overriden by this class */
91 NOMOVERRIDE(nomInit);
92 NOMOVERRIDE(nomUnInit);
93
94 /* Instance variables of this class. Theses are not
95 attributes. */
96 NOMINSTANCEVAR(string nomStringTitle);
97};
98
99#endif /* M_WPOBJECT_IDL_INCLUDED */
100
101
102
103
104
Note: See TracBrowser for help on using the repository browser.