Changeset 226 for trunk/gui

Timestamp:

Feb 4, 2007, 3:35:19 PM (19 years ago)

Author:

cinc

Message:

Added doxygen documentation for NOMWindow.

Location:

trunk/gui

Files:

• Makefile (modified) (3 diffs)
• class_c/nomwindow.c (modified) (1 diff)
• dox (added)
• dox/gui.dox (added)
• exports.def (modified) (1 diff)
• idl/nomwindow.idl (modified) (1 diff)

trunk/gui/Makefile

@@ -9 +9 @@
 OBJDIR          =       ./../../../o
 BINDIR          =       ./../../../bin
+DOCDIR          =       ./../../../docs
+
 CDIR            =       ./src
 
@@ -32 +34 @@
 
 CLASSOBJECTS    =       $(OBJDIR)/nomwindow.o \
-                        $(OBJDIR)/nomfolderwindow.o \
                         $(OBJDIR)/nommenu.o \
                         $(OBJDIR)/nommenuitem.o \
                         $(OBJDIR)/nomnotebook.o
+#                       $(OBJDIR)/nomfolderwindow.o \
 
 
 .PRECIOUS:      $(CLASSINC)/%.ih $(CLASSCDIR)/%.c $(CDIR)/%.c
+
+.PHONY:         dox
 
 all:    $(BINDIR)/$(DLLNAME).dll
@@ -88 +92 @@
         mkdir -p $(BINDIR)
         mkdir -p $(CLASSTEMPLATEDIR)
+        mkdir -p $(DOCDIR)
+
+dox:
+        cd ./dox && doxygen gui.dox
 
 clean:

trunk/gui/class_c/nomwindow.c

@@ -87 +87 @@
 }
 
+
+
+
+
+
+
+
+
+
+

trunk/gui/exports.def

@@ -9 +9 @@
         NOMWindowNewClass    
 
-        _NOMFolderWindowClassData  
-        _NOMFolderWindowCClassData 
-        NOMFolderWindowNewClass    
+;       _NOMFolderWindowClassData  
+;       _NOMFolderWindowCClassData 
+;       NOMFolderWindowNewClass    
 
         _NOMMenuClassData  

trunk/gui/idl/nomwindow.idl

@@ -46 +46 @@
 NOMCLASSNAME(NOMWindow);
 
+/** \class NOMWindow
+    This class represents a toplevel window.
+*/
 interface NOMWindow : NOMObject
 {
+  /**
+     Current class version is 1.0
+   */
   NOMCLASSVERSION(1, 0);
 
+  /**
+     Query the window handle from the instance data. This is the handle of the toplevel window,
+     not a child window handle.
+
+     \return Toplevel window handle.
+
+     \sa setWindowHandle.
+   */
   PGtkWidget queryWindowHandle();   
+
+  /**
+     Saves the toplevel window handle in the instance data.
+
+     \remark
+     When overriding don't save any child window handle using this method. It's only
+     for toplevel windows.
+
+     \param pgWidget Handle of a toplevel GTK window.
+
+     \sa queryWindowHandle()
+  */
   void setWindowHandle(in PGtkWidget pgWidget);   
+
+  /**
+     Shows a hidden window.
+
+     \sa present()
+   */
   void show();
+
+  /**
+     Hides the window.
+
+     \sa show()
+   */
   void hide();
+
+  /**
+     Brings a window to the front if covered by other windows. If the window
+     is iconofied it will be deiconofied and brought to the foreground.
+
+     \sa show()
+  */
   void present();
 
+  /**
+     Private variable holding the GtkWidget pointer.
+   */
   NOMINSTANCEVAR(PGtkWidget _pgWindowHandle);
 };