Mercurial > pidgin

comparison finch/libgnt/gntws.h @ 20874:acf284962b40

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add @since doxygen tags for finch/libgnt.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 10 Oct 2007 03:54:14 +0000
parents 44b4e8bd759b
children 406aa3be6b32
comparison
equal deleted inserted replaced
20869:2a6ef74f5a4e 20874:acf284962b40
67 void (*res4)(void); 67 void (*res4)(void);
68 }; 68 };
69 69
70 G_BEGIN_DECLS 70 G_BEGIN_DECLS
71 71
72 /**
73 * @return The GType for GntWS.
74 *
75 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
76 */
72 GType gnt_ws_get_gtype(void); 77 GType gnt_ws_get_gtype(void);
73 78
79 /**
80 * Create a new workspace with the specified name.
81 *
82 * @param name The desired name of the workspace, or @c NULL.
83 *
84 * @return The newly created workspace.
85 *
86 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
87 */
74 GntWS *gnt_ws_new(const char *name); 88 GntWS *gnt_ws_new(const char *name);
89
90 /**
91 * Set the name of a workspace.
92 *
93 * @param ws The workspace to rename.
94 * @param name The new name of the workspace.
95 *
96 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
97 */
75 void gnt_ws_set_name(GntWS *ws, const gchar *name); 98 void gnt_ws_set_name(GntWS *ws, const gchar *name);
99
100 /**
101 * Add a widget to a workspace.
102 *
103 * @param ws The workspace.
104 * @param widget The widget to add.
105 *
106 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
107 */
76 void gnt_ws_add_widget(GntWS *ws, GntWidget *widget); 108 void gnt_ws_add_widget(GntWS *ws, GntWidget *widget);
109
110 /**
111 * Remove a widget from a workspace.
112 *
113 * @param ws The workspace
114 * @param widget The widget to remove from the workspace.
115 *
116 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
117 */
77 void gnt_ws_remove_widget(GntWS *ws, GntWidget *widget); 118 void gnt_ws_remove_widget(GntWS *ws, GntWidget *widget);
119
120 /**
121 * Hide a widget in a workspace.
122 *
123 * @param widget The widget to hide.
124 * @param nodes A hashtable containing information about the widgets.
125 *
126 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
127 */
78 void gnt_ws_widget_hide(GntWidget *widget, GHashTable *nodes); 128 void gnt_ws_widget_hide(GntWidget *widget, GHashTable *nodes);
129
130 /**
131 * Show a widget in a workspace.
132 *
133 * @param widget The widget to show.
134 * @param nodes A hashtable containing information about the widgets.
135 *
136 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
137 */
79 void gnt_ws_widget_show(GntWidget *widget, GHashTable *nodes); 138 void gnt_ws_widget_show(GntWidget *widget, GHashTable *nodes);
139
140 /**
141 * Draw the taskbar in a workspace.
142 *
143 * @param ws The workspace.
144 * @param reposition Whether the workspace should reposition the taskbar.
145 *
146 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
147 */
80 void gnt_ws_draw_taskbar(GntWS *ws, gboolean reposition); 148 void gnt_ws_draw_taskbar(GntWS *ws, gboolean reposition);
149
150 /**
151 * Hide a workspace.
152 *
153 * @param ws The workspace to hide.
154 * @param table A hashtable containing information about the widgets.
155 *
156 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
157 */
81 void gnt_ws_hide(GntWS *ws, GHashTable *table); 158 void gnt_ws_hide(GntWS *ws, GHashTable *table);
159
160 /**
161 * Show a workspace.
162 *
163 * @param ws The workspace to hide.
164 * @param table A hashtable containing information about the widgets.
165 *
166 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
167 */
82 void gnt_ws_show(GntWS *ws, GHashTable *table); 168 void gnt_ws_show(GntWS *ws, GHashTable *table);
83 169
170 /**
171 * Get the name of a workspace.
172 *
173 * @param ws The workspace.
174 * @return The name of the workspace (can be @c NULL).
175 *
176 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
177 */
84 const char * gnt_ws_get_name(GntWS *ws); 178 const char * gnt_ws_get_name(GntWS *ws);
85 179
86 #endif 180 #endif