Changeset 224 for trunk/desktop


Ignore:
Timestamp:
Feb 4, 2007, 1:22:24 PM (19 years ago)
Author:
cinc
Message:

Added doxygen documentation.

Location:
trunk/desktop
Files:
2 added
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/desktop/Makefile

    r200 r224  
    99OBJDIR          =       ./../../../o
    1010BINDIR          =       ./../../../bin
     11DOCDIR          =       ./../../../docs
    1112CDIR            =       ./src
    1213
    … …  
    3637
    3738CLASSOBJECTS    =       $(OBJDIR)/wpobject.o \
     39                        $(OBJDIR)/wpnotebook.o \
     40                        $(OBJDIR)/wpfolderwindow.o \
    3841                        $(OBJDIR)/wpfilesystem.o \
    3942                        $(OBJDIR)/wpdatafile.o \
    4043                        $(OBJDIR)/wpfolder.o \
    4144                        $(OBJDIR)/wpwindow.o \
    42                         $(OBJDIR)/wpnotebook.o \
    43                         $(OBJDIR)/wpfolderwindow.o \
    4445                        $(OBJDIR)/wpclassmanager.o \
    4546                        $(OBJDIR)/m_wpobject.o \
    … …  
    4950                        $(OBJDIR)/helper.o
    5051
     52IHFILES         =       $(CLASSINC)/wpnativetypes.ih \
     53                        $(CLASSINC)/wpobject.ih \
     54                        $(CLASSINC)/wpnotebook.ih \
     55                        $(CLASSINC)/wpfolderwindow.ih \
     56                        $(CLASSINC)/wpfilesystem.ih \
     57                        $(CLASSINC)/wpdatafile.ih \
     58                        $(CLASSINC)/wpfolder.ih \
     59                        $(CLASSINC)/wpwindow.ih \
     60                        $(CLASSINC)/wpnotebook.ih \
     61                        $(CLASSINC)/wpclassmanager.ih \
     62                        $(CLASSINC)/m_wpobject.ih \
     63                        $(CLASSINC)/m_wpfilesystem.ih \
     64                        $(CLASSINC)/m_wpdatafile.ih \
     65                        $(CLASSINC)/m_wpfolder.ih
     66
     67#$(CLASSINC)/wpnativetypes.ih \
     68
    5169
    5270.PRECIOUS:      $(CLASSINC)/%.ih $(CLASSCDIR)/%.c $(CDIR)/%.c
     71
     72.PHONY:         dox
    5373
    5474all:    $(BINDIR)/voywp.dll $(BINDIR)/vdesktop.dll
    … …  
    6282
    6383
    64 $(BINDIR)/voywp.dll:     $(OBJDIR)/o.dep $(CLASSOBJECTS) exports.def
     84$(BINDIR)/voywp.dll:     $(OBJDIR)/o.dep $(IHFILES) $(CLASSOBJECTS) exports.def
    6585        @echo "[33;1;mLinking "$@"...[0;m"
    6686        @cmd.exe /C create_voywp_def $(OBJDIR)/voywp.def
    … …  
    85105        $(CC) -I $(INC) $(GCCFLAGS)  -o$@ $<
    86106
    87 $(OBJDIR)/helper.o:     $(CLASSCDIR)/helper.c
     107$(OBJDIR)/helper.o:     $(CLASSCDIR)/helper.c 
    88108        $(CC) -I $(INC) $(GCCFLAGS)  -o$@ $<
     109
     110$(CLASSINC)/wpnativetypes.ih:   $(IDLDIR)/wpnativetypes.idl
     111        $(BASE_NOMCOMPILEIH)
     112        $(BASE_NOMCOMPILEH)
     113
    89114
    90115$(CLASSINC)/%.ih:       $(IDLDIR)/%.idl
    … …  
    110135        mkdir -p $(BINDIR)
    111136        mkdir -p $(CLASSTEMPLATEDIR)
     137        mkdir -p $(DOCDIR)
     138
     139dox:
     140        cd ./dox && doxygen desktop.dox
    112141
    113142clean:

  • trunk/desktop/class_c/wpfolder.c

    r206 r224  
    3838 * And remember, phase 3 is near...
    3939 */
    40 #ifndef NOM_M_WPFolder_IMPLEMENTATION_FILE
    41 #define NOM_M_WPFolder_IMPLEMENTATION_FILE
     40#ifndef NOM_WPFolder_IMPLEMENTATION_FILE
     41#define NOM_WPFolder_IMPLEMENTATION_FILE
    4242#endif
    4343
    … …  
    7070#include "wpnotebook.h"
    7171#include "wpfolderwindow.h"
     72#include "m_wpfolder.h"
    7273#include "wpfolder.ih"
    73 #include "m_wpfolder.h"
     74
    7475#include "wpdatafile.h"
    7576#include "desktop.h"
    … …  
    9293  COL_DISPLAY_NAME,
    9394  COL_PIXBUF,
    94   COL_IS_DIRECTORY,
    9595  NUM_COLS
    9696};
    … …  
    104104                              G_TYPE_STRING,
    105105                              G_TYPE_STRING,
    106                               GDK_TYPE_PIXBUF,
    107                               G_TYPE_BOOLEAN);
    108   g_message("%s: store: %x", __FUNCTION__, (UINT) store);
     106                              GDK_TYPE_PIXBUF);
     107  // g_message("%s: store: %x", __FUNCTION__, (UINT) store);
    109108  return store;
    110109}
    … …  
    115114
    116115/***************************************************************/
    117 
     116/*
     117  The folder is already populated, that means the internal folder list
     118  is filled with all the objects in the folder. We traverse that list
     119  and fill the store utilisized by the icon view with the objects.
     120 */
    118121static
    119122gboolean fillStoreTraverseFunc(gpointer pKey, gpointer pTraverseValue, gpointer pData)
    … …  
    123126  gchar * display_name;
    124127  GtkListStore *store=(GtkListStore *)pData;
    125 
     128  WPObject* wpObject;
     129   
    126130  //  g_message("In %s with %s %x", __FUNCTION__, (char*)pKey, (UINT)pValue->wpObject);
    127131
    … …  
    129133  display_name=g_strdup(pKey); /* New string necessary? */ 
    130134
    131 
    132   if(!strcmp("WPDataFile", pValue->wpObject->mtab->nomClassName)){
    133     WPDataFile* wpDataFile;
    134 
    135     wpDataFile=(WPDataFile*)pValue->wpObject;
    136 
    137     if(nomIsObj(wpDataFile))
    138       {
    139         gtk_list_store_append (store, &iter);
    140        
    141 #warning !!!! some problems with icon handling here !!!!
    142         //nomPrintf("Icon ptr: %x\n", _wpQueryIcon((WPObject*)wpDataFile, NULLHANDLE));
    143         gtk_list_store_set (store, &iter,
    144                             COL_OBJECT_PTR, wpDataFile,
    145                             COL_PATH, "",
    146                             COL_DISPLAY_NAME, display_name,
    147                             COL_IS_DIRECTORY, FALSE,
    148                             COL_PIXBUF, _wpQueryIcon((WPObject*)wpDataFile, NULLHANDLE), //file_pixbuf,
    149                             -1);
    150       }
     135  wpObject=pValue->wpObject;
     136 
     137  if(nomIsObj(wpObject)){
     138#if 0
     139    g_message("%d %s : %s, %s",
     140              __LINE__, __FUNCTION__, (char*)pKey,
     141              NOMPath_queryCString(WPFolder_wpQueryFileName(wpFolder, TRUE, NULLHANDLE), NULLHANDLE));
     142#endif
     143   
     144    gtk_list_store_append (store, &iter);
     145   
     146    gtk_list_store_set (store, &iter,
     147                        COL_OBJECT_PTR, wpObject,
     148                        COL_PATH, "",
     149                        COL_DISPLAY_NAME, display_name,
     150                        COL_PIXBUF, _wpQueryIcon(wpObject, NULLHANDLE),
     151                        -1);
    151152  }
    152   else{
    153     WPFolder* wpFolder;
    154 
    155     wpFolder=(WPFolder*)pValue->wpObject;
    156 
    157     if(nomIsObj((NOMObject*)wpFolder)){
    158 #if 0
    159       g_message("%d %s : %s, %s",
    160                 __LINE__, __FUNCTION__, (char*)pKey,
    161                 NOMPath_queryCString(WPFolder_wpQueryFileName(wpFolder, TRUE, NULLHANDLE), NULLHANDLE));
    162 #endif
    163 
    164       gtk_list_store_append (store, &iter);
    165      
    166       gtk_list_store_set (store, &iter,
    167                           COL_OBJECT_PTR, wpFolder,
    168                           COL_PATH, "",
    169                           COL_DISPLAY_NAME, display_name,
    170                           COL_IS_DIRECTORY, TRUE,
    171                           COL_PIXBUF, _wpQueryIcon((WPObject*)wpFolder, NULLHANDLE), //folder_pixbuf ,
    172                           -1);
    173     }
    174   }
    175 
    176153  return FALSE; /* Traverse every item */
    177154}
    … …  
    181158{
    182159  WPFolderData* nomThis=WPFolderGetData(nomSelf);
    183 
    184   nomPrintf("In %s:  %s\n", __FUNCTION__, gchrPath);         
    185160
    186161  /* First clear the store */
    … …  
    273248              wpObject=NULLHANDLE;
    274249          }
     250
    275251          if(nomIsObj((PNOMObject)wpObject))
    276252            {
    … …  
    279255              WPFileSystem_tstSetFullPath((WPFileSystem*)wpObject, gchrCurrentEntry, NULLHANDLE);
    280256              WPFileSystem_wpSetFolder(wpObject, nomSelf, NULLHANDLE);
    281 #if 9
     257#if 0
    282258              g_message("%d %s : %s (%x) , %s",
    283259                        __LINE__, __FUNCTION__, gchrCurrentEntry, (UINT)wpObject,
    … …  
    319295  g_return_val_if_fail(NULLHANDLE!=wpWindow, FALSE);
    320296
    321   /* This call will be different when using WPFolderWindow */
    322   //wpObject=NOMFolderWindow_wpQueryWPFolderObject(wpWindow, NULLHANDLE);
    323297  wpObject=pUseItem->wpObject;
    324298  g_return_val_if_fail(NULLHANDLE!=wpObject, FALSE);
    325299
    326300  WPObject_wpSaveDeferred(wpObject, NULLHANDLE);
    327 
     301  /* Remove the open folder view from the inuse list */
    328302  WPObject_wpDeleteFromObjUseList(wpObject, pUseItem, NULLHANDLE);
    329303
    … …  
    344318  /* Special parameter representing a double click or "I just don't know" ;-) */
    345319  if(OPEN_DEFAULT==ulView)
    346     ulV=WPObject_wpQueryDefaultView(nomSelf, &nSpaceId, NULLHANDLE);
     320    ulV=WPFolder_wpQueryDefaultView(nomSelf, &nSpaceId, NULLHANDLE);
    347321
    348322  /* We only handle items with in own name space */
    … …  
    361335            GtkIconView*  gtkIconView;
    362336
    363             pszPath=NOMPath_queryCString(WPFolder_wpQueryFileName(nomSelf, TRUE, NULLHANDLE), NULLHANDLE);
     337            pszPath=NOMPath_queryCString(_wpQueryFileName(nomSelf, TRUE, NULLHANDLE), NULLHANDLE);
    364338            g_message("%d %s, %s", __LINE__, __FUNCTION__, pszPath);
    365339            WPFolder_wpPopulate(nomSelf, 0L, pszPath, FALSE,  NULLHANDLE);
    … …  
    370344           
    371345            /* Insert it into inuse list */
    372             pui=(PUSEITEM)WPFolder_wpAllocMem(nomSelf, sizeof(USEITEM)+sizeof(VIEWITEM), &ulError, ev);
     346            pui=(PUSEITEM)WPFolder_wpAllocMem(nomSelf, sizeof(USEITEM)+sizeof(VIEWITEM), &ulError, NULLHANDLE);
    373347            /* Fill the structures */
    374348            pui->type=(gulong)USAGE_OPENVIEW;
    … …  
    379353            ((VIEWITEM*)pui)->nameSpaceId=WPFolderNomId;
    380354            pui--;
    381 #warning !!!!! Folder window must be inserted into inuse list !!!!!
     355
    382356            /* Make sure the view item is removed when the window is closed */
    383357            g_signal_connect(G_OBJECT(NOMWindow_queryWindowHandle((NOMWindow*)wpFldrWindow, NULLHANDLE)),"delete-event",

  • trunk/desktop/class_c/wpfolderwindow.c

    r206 r224  
    116116        PWPFolderWindow pWindow;
    117117        GtkTreePath* treePath;
    118         DosBeep(5000, 100);
     118        //DosBeep(5000, 100);
    119119        pWindow=(WPFolderWindow*)user_data;
    120         TST_OBJECT(pWindow);
     120        //TST_OBJECT(pWindow);
    121121        treePath=gtk_icon_view_get_path_at_pos(GTK_ICON_VIEW(widget), event->x, event->y );
    122122        if(NULL==treePath)
    … …  
    166166}
    167167
    168 /* orbit-idl-c-stubs.c, cs_output_stub line 347 */
    169168NOM_Scope void NOMLINK impl_WPFolderWindow_nomInit(WPFolderWindow* nomSelf, CORBA_Environment *ev)
    170169{
    … …  
    185184  /* Folder toplevel window. */
    186185  window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
    187   /* Set title */
    188   //  gtk_window_set_title (GTK_WINDOW (window), "");
    189186
    190187  /* FIXME: Set default size of folder frame. Will later use a stored value */
    … …  
    278275}
    279276
     277

  • trunk/desktop/class_c/wpobject.c

    r209 r224  
    6969/***************************************************************/
    7070
     71/**
     72   \brief Function which implements the wpAllocMem() method of WPObject.
     73 */
    7174NOM_Scope gpointer NOMLINK impl_WPObject_wpAllocMem(WPObject* nomSelf, const gulong cbBytes,
    7275                                                    gulong* prc, CORBA_Environment *ev)
    … …  
    99102}
    100103
     104/**
     105   \brief Function which implements the wpFreeMem() method of WPObject.
     106 */
    101107NOM_Scope CORBA_boolean NOMLINK impl_WPObject_wpFreeMem(WPObject* nomSelf, const gpointer pByte, CORBA_Environment *ev)
    102108{
    … …  
    115121}
    116122
     123/**
     124   \brief Override of nomInit() from NOMObject.
     125 */
    117126NOM_Scope void NOMLINK impl_WPObject_nomInit(WPObject* nomSelf, CORBA_Environment *ev)
    118127{
    … …  
    146155}
    147156
     157/**
     158   \brief Function which implements the wpInitData() method of WPObject.
     159 */
    148160NOM_Scope void NOMLINK impl_WPObject_wpInitData(WPObject* nomSelf, CORBA_Environment *ev)
    149161{
    … …  
    159171}
    160172
     173/**
     174   \brief Function which implements the wpUnInitData() method of WPObject.
     175 */
    161176NOM_Scope void NOMLINK impl_WPObject_wpUnInitData(WPObject* nomSelf, CORBA_Environment *ev)
    162177{
    … …  
    189204}
    190205
     206/**
     207   \brief Function which implements the wpOpen() method of WPObject.
     208 */
    191209NOM_Scope gpointer NOMLINK impl_WPObject_wpOpen(WPObject* nomSelf, const PWPFolderWindow nomFolder,
    192210                                                const gulong ulView, const nomId nameSpaceId,
    … …  
    250268}
    251269
     270/**
     271   \brief Function which implements the wpViewObject() method of WPObject.
     272 */
    252273NOM_Scope gpointer NOMLINK impl_WPObject_wpViewObject(WPObject* nomSelf, const PWPFolderWindow nomFolder,
    253274                                                      const gulong ulView, const nomId nameSpaceId,
    … …  
    272293}
    273294
     295/**
     296   \brief Function which implements the wpSwitchTo() method of WPObject.
     297 */
    274298NOM_Scope gpointer NOMLINK impl_WPObject_wpSwitchTo(WPObject* nomSelf, const gulong ulView, const nomId nameSpaceId,
    275299                                                    CORBA_Environment *ev)
    … …  
    289313}
    290314
     315/**
     316   \brief Function which implements the wpRegisterView() method of WPObject.
     317 */
    291318NOM_Scope CORBA_boolean NOMLINK impl_WPObject_wpRegisterView(WPObject* nomSelf, const PNOMWindow pWindow,
    292319                                                             const PNOMString nomStrViewTitle, CORBA_Environment *ev)
    … …  
    298325}
    299326
     327/**
     328   \brief Function which implements the wpAddToObjUseList() method of WPObject.
     329 */
    300330NOM_Scope CORBA_boolean NOMLINK impl_WPObject_wpAddToObjUseList(WPObject* nomSelf, const PUSEITEM pUseItem,
    301331                                                                CORBA_Environment *ev)
    … …  
    317347}
    318348
     349/**
     350   \brief Function which implements the wpDeleteFromObjUseList() method of WPObject.
     351 */
    319352NOM_Scope CORBA_boolean NOMLINK impl_WPObject_wpDeleteFromObjUseList(WPObject* nomSelf, const PUSEITEM pUseItem,
    320353                                                                     CORBA_Environment *ev)

  • trunk/desktop/class_h/wpnativetypes.h

    r108 r224  
    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 ***** */
     1/*
     2 * This file was generated by orbit-idl-2 for Voyager - DO NOT EDIT!
     3 *
     4 *
     5 * And remember, phase 3 is near...
     6 */
     7
     8/*
     9 * idl/wpnativetypes.idl
     10 */
     11
     12#ifndef wpnativetypes_H
     13#define wpnativetypes_H 1
     14
     15#include <glib.h>
     16
     17#include <nomcls.h> /* This is needed for _nomNew() */
     18
     19#ifdef __cplusplus
     20extern "C" {
     21#endif /* __cplusplus */
     22
     23
     24/** typedefs **/
     25/* from IDL source file "idl/wpnativetypes.idl" (seen 0, isTop 1, wasInhibit 0) */
     26
     27/** stub prototypes **/
     28  /* (orbit-idl-c-headers.c, orbit_idl_output_c_headers line 65) */
     29
     30/** Voyager **/
     31#ifdef __cplusplus
     32}
     33#endif /* __cplusplus */
     34
     35#endif /* wpnativetypes_H */

  • trunk/desktop/idl/wpobject.idl

    r209 r224  
    6969
    7070  /* Memory allocation */
     71  /**
     72     Allocate a block of \e cbBytes length. The storage area
     73     is tracked in the objects inuse list.
     74
     75     \par How to override
     76     This method is usually not overriden.
     77
     78     \param cbBytes Number of bytes to allocate.
     79     \param prc Pointer to a gulong which will hold an error code if the method fails.
     80     \return A pointer to the block of memory
     81
     82     \sa wpFreeMem()
     83   */
    7184  gpointer wpAllocMem(in gulong cbBytes,
    7285                      in pgulong prc);
     86  /**
     87     Free a block of memory. The method removes the memory block from the objects inuse
     88     list. Because NOM uses a garbage collector the memory isn't freed instantly but
     89     will be collected later.
     90
     91     \par How to override
     92     This method is usually not overriden.
     93
     94     \param pByte Block of memory to be freed.
     95     \return TRUE if successful.
     96
     97     \sa wpAllocMem()
     98   */
    7399  boolean  wpFreeMem(in gpointer pByte);
     100
     101  /**
     102     Method to be overriden by objects when they need to do some setup.
     103
     104     \remark Desktop classes should override this method instead of nomInit().
     105
     106     \par How to override
     107     This method should be overriden by classes which need initialization. The parent
     108     must be called first.
     109
     110     \sa wpUnInitData()
     111   */
    74112  void     wpInitData();
     113
     114  /**
     115     Method to be overriden by objects when they need to do some unititialization work.
     116
     117     \remark Desktop classes should override this method instead of nomUnInit().
     118
     119     \par How to override
     120     This method should be overriden by classes which need uninitialization. The parent must
     121     be called last.
     122
     123     \sa wpInitData()
     124   */
    75125  void     wpUnInitData();
     126
     127  /**
     128     This method always opens a new view of an object. The concurrent view setting is not
     129     taken into account. wpViewObject() should be called most of the time.
     130
     131     \par How to override
     132     Desktop objects override this method when they have a private view.
     133
     134     \param nomFolder The folder view (window) containing the object. Note that an object may
     135     live in different folder windows at the same time.
     136     \param ulView The view to be opened.
     137     \param nameSpaceId See menu handling for more information.
     138     \param pParam Reserved and must be set to NULL.
     139     \return A pointer to the view.
     140
     141     \sa wpViewObject()
     142  */
    76143  gpointer wpOpen(in PWPFolderWindow nomFolder, in gulong ulView, in nomId nameSpaceId, in gpointer pParam);
     144
     145  /**
     146     Increase the use counter of the object.
     147
     148     \remark The increment operation on the internal counter is an atomic operation but be aware
     149     that the method call itself is not.
     150
     151     \par How to override
     152     This method is usually not overriden.
     153
     154     \sa wpObjectIsLocked(), wpUnlockObject()
     155   */
    77156  void     wpLockObject();
     157
     158  /**
     159     Decrease the use counter of the object.
     160
     161     \remark When the use counter of an object reaches 0 the object will be destroyed.
     162     The decrement operation on the internal counter is an atomic operation but be aware
     163     that the method call itself is not.
     164
     165     \par How to override
     166     This method is usually not overriden.
     167
     168     \sa wpObjectIsLocked(), wpLockObject()
     169   */
    78170  boolean  wpUnlockObject();
     171
     172  /**
     173     Query if the object is in use.
     174
     175     \remark This method reflects the state of the object at the time of the call. Note that
     176     in a multithreaded environment other threads may alter the use counter at any time.
     177
     178     \par How to override
     179     This method is usually not overriden.
     180
     181     \return TRUE if the objects use counter is greater than 0. This means the object is still in use.
     182
     183     \sa wpLockObject(), wpUnlockObject()
     184   */
    79185  boolean  wpObjectIsLocked();
    80186  gpointer wpQueryIcon();
     187
     188  /**
     189
     190   */
    81191  unsigned long  wpRequestObjectMutexSem(in unsigned long ulReserved);
    82192  unsigned long  wpReleaseObjectMutexSem();
    … …  
    98208  unsigned long wpAddObjectGeneralPage(in PWPNoteBook wpNoteBook);
    99209
     210  /**
     211     This method either resurfaces an existing view or creates a new view according to the
     212     objects concurrent view setting.
     213
     214     If concurrent view is set to \e No the objects inuse list is searched for an existing
     215     view of the kind being requested. If found the view is brought to the front. If concurrent
     216     view setting is \e yes or no view can be found wpOpen() is called to create a new view.
     217
     218     \remark This method should be use in preference to the wpOpen() method.
     219
     220     \par How to override
     221     This method is usually not overriden.
     222
     223     \param nomFolder The folder view (window) containing the object. Note that an object may
     224     live in different folder windows at the same time.
     225     \param ulView The view to be opened.
     226     \param nameSpaceId See menu handling for more information.
     227     \param pParam Reserved and must be set to NULL.
     228     \return A pointer to the view.
     229
     230     \sa wpOpen(), wpSwitchTo()
     231   */
    100232  gpointer wpViewObject(in PWPFolderWindow nomFolder, in gulong ulView, in nomId nameSpaceId, in gpointer pParam);
     233
     234  /**
     235     Search the objects inuse list for the given view and if found bring it to the front.
     236
     237     \par How to override
     238     This method is usually not overriden.
     239
     240     \param ulView The view to be opened.
     241     \param nameSpaceId See menu handling for more information.
     242     \return A pointer to the view or NULL if no view exists.
     243
     244     \sa wpViewObject()
     245   */
    101246  gpointer wpSwitchTo(in gulong ulView, in nomId nameSpaceId);
    102247  boolean wpRegisterView(in PNOMWindow pWindow, in PNOMString nomStrViewTitle);
    103248
    104   /* Inuse list methods */
     249  /* ---- Inuse list methods ---- */
     250
     251  /**
     252     Register an inuse item in the objects inuse list. Inuse items may describe blocks of
     253     memory used by the object, open views and some more.
     254
     255     \How to override
     256     This method is usually not overriden.
     257
     258     \param
     259     \return TRUE if success.
     260
     261     \sa wpDeleteFromObjUseList(), wpFindUseItem(), wpFindViewItem()
     262   */
    105263  boolean   wpAddToObjUseList(in PUSEITEM pUseItem);
     264
     265  /**
     266     Remove an inuse item from the objects inuse list. Inuse items may describe blocks of
     267     memory used by the object, open views and some more.
     268
     269     \remark The use item will not be freed by this method.
     270
     271     \par How to override
     272     This method is usually not overriden.
     273
     274     \param pUseItem Use item to be removed from the objects inuse list.
     275     \return TRUE if success.
     276
     277     \sa wpAddToObjUseList(), wpFindUseItem(), wpFindViewItem()
     278  */
    106279  boolean   wpDeleteFromObjUseList(in PUSEITEM pUseItem);
     280
     281  /**
     282     \sa wpAddToObjUseList(), wpDeleteFromObjUseList(), wpFindViewItem()
     283   */
    107284  PUSEITEM  wpFindUseItem( in gulong ulType, in PUSEITEM pCurrentUseItem);
    108   PVIEWITEM wpFindViewItem(in gulong ulView, in nomId nameSpaceId, in PVIEWITEM pCurrentItem);
     285  PVIEWITEM wpFindViewItem( in gulong ulView, in nomId nameSpaceId, in PVIEWITEM pCurrentItem);
    109286
    110287  boolean wpSaveDeferred();
    … …  
    112289
    113290  void wpSetFolder(in PWPFolder wpParentFolder);
     291
     292  /**
     293     Get the folder this object is living in.
     294
     295     \return Folder object. Note that this is not a folder view (window)
     296
     297     \sa wpSetFolder()
     298   */
    114299  PWPFolder wpQueryFolder();
    115300
    … …  
    123308
    124309  /* Methods overriden by this class */
     310
     311  /**
     312     Override of nomInit(). The object semaphore for serializing access to
     313     objects data is created here. After setting it up wpInitData() is called.
     314     This method should be overriden by desktop classes instead of nomInit().
     315   */
    125316  NOMOVERRIDE(nomInit);
     317
     318  /**
     319     Override of nomUnInit(). First wpUnitData() is called on the object. Note
     320     that desktop classes should override wpUnInitData() instead of nomUnInit.
     321
     322     After destroying the object semaphor nomUnInit() is called.
     323
     324     \remark This override will put any desktop object on the list of objects with
     325     finalizers.
     326   */
    126327  NOMOVERRIDE(nomUnInit);
    127328
    128329  /* Instancce variables of this class. Theses are not
    129330     attributes. */
     331  /**
     332     Object lock counter instance variable. This variable is private and can't be accessed
     333     from the outside.
     334
     335     \sa wpObjectIsLocked(), wpLockObject(), wpUnlockObject()
     336   */
    130337  NOMINSTANCEVAR(gint iLockCounter);
     338
     339  /**
     340     Object semaphor. This variable is private and can't be accessed
     341     from the outside.
     342
     343     \sa wpRequestObjectMutexSem(), wpReleaseObjectMutexSem()
     344   */
    131345  NOMINSTANCEVAR(HMUX gObjectMutex);
    132346  NOMINSTANCEVAR(PGSList glstObjectInUse);

  • trunk/desktop/src/vdesktop.c

    r200 r224  
    3232*
    3333* ***** END LICENSE BLOCK ***** */
    34 
    3534#define INCL_DOSPROCESS
    3635#define INCL_DOS
    … …  
    5756#include "wpfolderwindow.h"
    5857#include "wpnotebook.h"
     58#include "m_wpfolder.h"
    5959#include "wpfolder.h"
    6060#include "wpobject.h"
    … …  
    119119  //  g_assert(nomRegisterDLLByName(hReg, "PBL-PNG.DLL"));
    120120  //  g_assert(nomRegisterDLLByName(hReg, "BASIC-FC.DLL"));
    121   /* Add Pango here? */
     121  /* Add Pango */
    122122  g_assert(nomRegisterDLLByName(hReg, "PANGO.DLL"));
    123123  nomEndRegisterDLLWithGC(hReg);
    … …  
    141141    Bootstrap our objects...
    142142  */
     143#if 0
    143144  pEnv=nomTkInit();
    144145
    … …  
    147148    return(1);
    148149  }
    149 
    150   /* Init SOM */
     150#endif
     151
     152  /* Init NOM */
    151153  NOMClassMgrObject=nomEnvironmentNew();
    152154  //dbgPrintf( "NOMClassMgrObject: %x", NOMClassMgrObject);
Note: See TracChangeset for help on using the changeset viewer.