2 * @defgroup gnt GNT (GLib Ncurses Toolkit)
4 * GNT is an ncurses toolkit for creating text-mode graphical user interfaces
5 * in a fast and easy way.
12 * GNT - The GLib Ncurses Toolkit
14 * GNT is the legal property of its developers, whose names are too numerous
15 * to list here. Please refer to the COPYRIGHT file distributed with this
16 * source distribution.
18 * This library is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
37 #include "gntwidget.h"
38 #include "gntclipboard.h"
39 #include "gntcolors.h"
43 * Get things to compile in Glib < 2.8
45 #if !GLIB_CHECK_VERSION(2,8,0)
46 #define G_PARAM_STATIC_NAME G_PARAM_PRIVATE
47 #define G_PARAM_STATIC_NICK G_PARAM_PRIVATE
48 #define G_PARAM_STATIC_BLURB G_PARAM_PRIVATE
57 * Start running the mainloop for gnt.
62 * Check whether the terminal is capable of UTF8 display.
64 * @return @c FALSE if the terminal is capable of drawing UTF-8, @c TRUE otherwise.
66 gboolean
gnt_ascii_only(void);
69 * Present a window. If the event was triggered because of user interaction,
70 * the window is moved to the foreground. Otherwise, the Urgent hint is set.
72 * @param window The window the present.
74 * @since 2.0.0 (gnt), 2.1.0 (pidgin)
76 void gnt_window_present(GntWidget
*window
);
80 * Use #gnt_widget_show instead.
82 void gnt_screen_occupy(GntWidget
*widget
);
86 * Use #gnt_widget_hide instead.
88 void gnt_screen_release(GntWidget
*widget
);
92 * Use #gnt_widget_draw instead.
94 void gnt_screen_update(GntWidget
*widget
);
99 * @param widget The widget to resize.
100 * @param width The desired width.
101 * @param height The desired height.
103 void gnt_screen_resize_widget(GntWidget
*widget
, int width
, int height
);
108 * @param widget The widget to move.
109 * @param x The desired x-coordinate.
110 * @param y The desired y-coordinate.
112 void gnt_screen_move_widget(GntWidget
*widget
, int x
, int y
);
117 * @param widget The widget to rename.
118 * @param text The new name for the widget.
120 void gnt_screen_rename_widget(GntWidget
*widget
, const char *text
);
123 * Check whether a widget has focus.
125 * @param widget The widget.
127 * @return @c TRUE if the widget has the current focus, @c FALSE otherwise.
129 gboolean
gnt_widget_has_focus(GntWidget
*widget
);
132 * Set the URGENT hint for a widget.
134 * @param widget The widget to set the URGENT hint for.
136 void gnt_widget_set_urgent(GntWidget
*widget
);
139 * Register a global action.
141 * @param label The user-visible label for the action.
142 * @param callback The callback function for the action.
144 void gnt_register_action(const char *label
, void (*callback
)(void));
149 * @param menu The menu to display.
151 * @return @c TRUE if the menu is displayed, @c FALSE otherwise (e.g., if another menu is currently displayed).
153 gboolean
gnt_screen_menu_show(gpointer menu
);
156 * Terminate the mainloop of gnt.
161 * Get the global clipboard.
163 * @return The clipboard.
165 GntClipboard
* gnt_get_clipboard(void);
168 * Get the string in the clipboard.
170 * @return A copy of the string in the clipboard. The caller must @c g_free the string.
172 gchar
* gnt_get_clipboard_string(void);
175 * Set the contents of the global clipboard.
177 * @param string The new content of the new clipboard.
179 void gnt_set_clipboard_string(const gchar
*string
);
182 * Spawn a different application that will consume the console.
184 * @param wd The working directory for the new application.
185 * @param argv The argument vector.
186 * @param envp The environment, or @c NULL.
187 * @param stin Location to store the child's stdin, or @c NULL.
188 * @param stout Location to store the child's stdout, or @c NULL.
189 * @param sterr Location to store the child's stderr, or @c NULL.
190 * @param callback The callback to call after the child exits.
191 * @param data The data to pass to the callback.
193 * @return @c TRUE if the child was successfully spawned, @c FALSE otherwise.
195 gboolean
gnt_giveup_console(const char *wd
, char **argv
, char **envp
,
196 gint
*stin
, gint
*stout
, gint
*sterr
,
197 void (*callback
)(int status
, gpointer data
), gpointer data
);
200 * Check whether a child process is in control of the current terminal.
202 * @return @c TRUE if a child process (eg., PAGER) is occupying the current
203 * terminal, @c FALSE otherwise.
205 gboolean
gnt_is_refugee(void);