* improvements in display of address, refactored some code

[modest] / src / modest-window-mgr.h

diff --git a/src/modest-window-mgr.h b/src/modest-window-mgr.h
index 2223651..e872610 100644 (file)
--- a/src/modest-window-mgr.h
+++ b/src/modest-window-mgr.h
@@ -1,5 +1,34 @@
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
 /* modest-window-mgr.h */
-/* insert (c)/licensing information) */
 
 #ifndef __MODEST_WINDOW_MGR_H__
 #define __MODEST_WINDOW_MGR_H__
@@ -50,15 +79,60 @@ struct _ModestWindowMgrClass {
 /* member functions */
 GType        modest_window_mgr_get_type    (void) G_GNUC_CONST;
 
-/* typical parameter-less _new function */
-/* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
-/*    otherwise probably a GObject*. */
+/**
+ * modest_window_mgr_new:
+ *
+ * creates a new ModestWindowMgr instance
+ *
+ * Returns: a new ModestWindowMgr, or NULL in case of error
+ */
 GObject*    modest_window_mgr_new         (void);
 
+/**
+ * modest_window_mgr_register:
+ * @self: a ModestWindowMgr instance
+ * @win: the GObject of the window to register
+ * @type: ModestWindowType of the window to register
+ * @window_id: a guint window_id of the window
+ *
+ * register a window with the ModestWindowMgr instance *self
+ *
+ * Returns: TRUE on success, else FALSE
+ */
 gboolean    modest_window_mgr_register   (ModestWindowMgr *self, GObject *win,
                                          ModestWindowType type, guint window_id);
+
+/**
+ * modest_window_mgr_unregister:
+ * @self: a ModestWindowMgr instance
+ * @win: the GObject of the window to register
+ *
+ * unregister a window from the ModestWindowMgr instance *self
+ *
+ * Returns: TRUE on success, else FALSE
+ */
 gboolean    modest_window_mgr_unregister (ModestWindowMgr *self, GObject *win);
+
+/**
+ * modest_window_mgr_find_by_type:
+ * @self: a ModestWindowMgr instance
+ * @type: the ModestWindowType to search for
+ *
+ * search for a window of type 'type' in the ModestWindowMgr instance *self
+ *
+ * Returns: the GObject of the window, else NULL
+ */
 GObject*    modest_window_mgr_find_by_type (ModestWindowMgr *self, ModestWindowType type);
+
+/**
+ * modest_window_mgr_find_by_id:
+ * @self: a ModestWindowMgr instance
+ * @window_id: the ModestWindowType to search for
+ *
+ * search for a window with a specific 'window_id' in the ModestWindowMgr instance *self
+ *
+ * Returns: the GObject of the window, else NULL
+ */
 GObject*    modest_window_mgr_find_by_id (ModestWindowMgr *self, gint window_id);
 
 G_END_DECLS