source: trunk/desktop/idl/wpobject.idl@ 189

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

Code and IDL file cleanups.
File size: 4.7 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 WPOBJECT_IDL_INCLUDED
36#define WPOBJECT_IDL_INCLUDED
37
38#include <nomobj.idl>
39
40NOMCLASSNAME(WPObject);
41
42#include "wpnativetypes.idl"
43#include "nomstring.idl"
44#include "nommenu.idl"
45#include "nommenuitem.idl"
46#include "nomwindow.idl"
47
48#ifndef WPFLDRWINDOW_IDL_INCLUDED
49native PWPFolderWindow;
50#endif
51
52#ifndef WPFOLDER_IDL_INCLUDED
53native PWPFolder;
54#endif
55
56#if 1
57#ifndef WPNOTEBOOK_IDL_INCLUDED
58native PWPNoteBook;
59#endif
60#else
61#include "wpnotebook.idl"
62#endif
63
64interface WPObject : NOMObject
65{
66 NOMCLASSVERSION(1, 0);
67
68 /* Memory allocation */
69 gpointer wpAllocMem(in gulong cbBytes,
70 in pgulong prc);
71 boolean wpFreeMem(in gpointer pByte);
72 void wpInitData();
73 void wpUnInitData();
74 gpointer wpOpen(in PWPFolderWindow nomFolder, in gulong ulView, in gpointer pParam);
75 void wpLockObject();
76 boolean wpUnlockObject();
77 boolean wpObjectIsLocked();
78 gpointer wpQueryIcon();
79 unsigned long wpRequestObjectMutexSem(in unsigned long ulReserved);
80 unsigned long wpReleaseObjectMutexSem();
81
82 void wpSetTitle(in PNOMString pnomStrNewTitle);
83 PNOMString wpQueryTitle();
84
85 PNOMMenu wpDisplayMenu(in PWPFolderWindow nomFolder, in gpointer gReserved, in unsigned long ulMenuType,
86 in unsigned long ulReserved);
87 void wpModifyMenu(in PWPFolderWindow nomFolder, in PNOMMenu nomMenu, in unsigned long ulMenuType);
88 void wpFilterMenu(in PWPFolderWindow nomFolder, in PNOMMenu nomMenu, in unsigned long ulMenuType,
89 in unsigned long ulFlags);
90 boolean wpMenuItemSelected(in PWPFolderWindow nomFolder, in PNOMMenuItem nomMenuItem);
91 void wpInsertMenuItem( in PNOMMenu nomMenu, in PNOMMenuItem nomMenuItem, in unsigned long ulPosition);
92
93 /* Settings pages */
94 boolean wpAddSettingsPages(in PWPNoteBook wpNoteBook);
95 unsigned long wpInsertSettingsPage(in PWPNoteBook wpNoteBook, in gpointer ppageinfo);
96 unsigned long wpAddObjectGeneralPage(in PWPNoteBook wpNoteBook);
97
98 gpointer wpViewObject(in PWPFolderWindow nomFolder, in gulong ulView, in gpointer pParam);
99 gpointer wpSwitchTo(in gulong ulView);
100 boolean wpRegisterView(in PNOMWindow pWindow, in PNOMString nomStrViewTitle);
101
102 /* Inuse list methods */
103 boolean wpAddToObjUseList(in PUSEITEM pUseItem);
104 boolean wpDeleteFromObjUseList(in PUSEITEM pUseItem);
105 PUSEITEM wpFindUseItem( in gulong ulType, in PUSEITEM pCurrentUseItem);
106 PVIEWITEM wpFindViewItem(in gulong flViews,in PVIEWITEM pCurrentItem);
107
108 boolean wpSaveDeferred();
109 boolean wpSaveImmediate();
110
111 void wpSetFolder(in PWPFolder wpParentFolder);
112 PWPFolder wpQueryFolder();
113
114 void wpSetTitleFromCString(in string chrNewTitle);
115
116 /* Methods overriden by this class */
117 NOMOVERRIDE(nomInit);
118 NOMOVERRIDE(nomUninit);
119
120 /* Instancce variables of this class. Theses are not
121 attributes. */
122 NOMINSTANCEVAR(gint iLockCounter);
123 NOMINSTANCEVAR(HMUX gObjectMutex);
124 NOMINSTANCEVAR(PGSList glstObjectInUse);
125 NOMINSTANCEVAR(PNOMString pnomStringTitle);
126 NOMINSTANCEVAR(PWPFolder wpParentFldr);
127};
128
129#endif /* WPOBJECT_IDL_INCLUDED */
130
131
132
133
134
Note: See TracBrowser for help on using the repository browser.