Merge pull request #482 from philippwiesemann/fix-typos-po-de
[geany-mirror.git] / src / ui_utils.h
blob98a2e8a44babbcaec12645f468fe26fda470981c
1 /*
2 * ui_utils.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #ifndef GEANY_UI_UTILS_H
23 #define GEANY_UI_UTILS_H 1
25 #include "document.h"
27 #include "gtkcompat.h"
29 G_BEGIN_DECLS
31 /** Sets a name to lookup @a widget from @a owner.
32 * @param owner Usually a window, dialog or popup menu.
33 * @param widget Widget.
34 * @param widget_name Name.
35 * @see ui_lookup_widget().
37 * @since 0.16
38 **/
39 #define ui_hookup_widget(owner, widget, widget_name) \
40 g_object_set_data_full(G_OBJECT(owner), widget_name, \
41 g_object_ref(widget), (GDestroyNotify)g_object_unref);
44 /** Interface preferences */
45 typedef struct GeanyInterfacePrefs
47 gboolean sidebar_symbol_visible; /**< whether the symbol sidebar is visible */
48 gboolean sidebar_openfiles_visible; /**< whether the open file list is visible */
49 gchar *editor_font; /**< editor font */
50 gchar *tagbar_font; /**< symbol sidebar font */
51 gchar *msgwin_font; /**< message window font */
52 gboolean show_notebook_tabs; /**< whether editor tabs are visible */
53 gint tab_pos_editor; /**< positions of editor's tabs */
54 gint tab_pos_msgwin; /**< positions of message window's tabs */
55 gint tab_pos_sidebar; /**< positions of sidebar's tabs */
56 gboolean statusbar_visible; /**< whether the status bar is visible */
57 gboolean show_symbol_list_expanders; /**< whether to show expanders in the symbol list */
58 /** whether a double click on notebook tabs hides all other windows */
59 gboolean notebook_double_click_hides_widgets;
60 gboolean highlighting_invert_all; /**< whether highlighting colors are inverted */
61 gint sidebar_pos; /**< position of the sidebar (left or right) */
62 gboolean msgwin_status_visible; /**< whether message window's status tab is visible */
63 gboolean msgwin_compiler_visible; /**< whether message window's compiler tab is visible */
64 gboolean msgwin_messages_visible; /**< whether message window's messages tab is visible */
65 gboolean msgwin_scribble_visible; /**< whether message window's scribble tab is visible */
66 /** whether to use native Windows' dialogs (only used on Windows) */
67 gboolean use_native_windows_dialogs;
68 /** whether compiler messages window is automatically scrolled to show new messages */
69 gboolean compiler_tab_autoscroll;
70 gint msgwin_orientation; /**< orientation of the message window */
72 GeanyInterfacePrefs;
75 /** Important widgets in the main window.
76 * Accessed by @c geany->main_widgets. */
77 typedef struct GeanyMainWidgets
79 GtkWidget *window; /**< Main window. */
80 GtkWidget *toolbar; /**< Main toolbar. */
81 GtkWidget *sidebar_notebook; /**< Sidebar notebook. */
82 GtkWidget *notebook; /**< Document notebook. */
83 GtkWidget *editor_menu; /**< Popup editor menu. */
84 GtkWidget *tools_menu; /**< Most plugins add menu items to the Tools menu. */
85 /** Progress bar widget in the status bar to show progress of various actions.
86 * See ui_progress_bar_start() for details. */
87 GtkWidget *progressbar;
88 GtkWidget *message_window_notebook; /**< Message Window notebook. */
89 /** Plugins modifying the project can add their items to the Project menu. */
90 GtkWidget *project_menu;
92 GeanyMainWidgets;
95 #define GEANY_STOCK_SAVE_ALL "geany-save-all"
96 #define GEANY_STOCK_CLOSE_ALL "geany-close-all"
97 #define GEANY_STOCK_BUILD "geany-build"
100 GtkWidget *ui_dialog_vbox_new(GtkDialog *dialog);
102 GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alignment);
104 void ui_set_statusbar(gboolean log, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
106 void ui_table_add_row(GtkTable *table, gint row, ...) G_GNUC_NULL_TERMINATED;
108 GtkWidget *ui_path_box_new(const gchar *title, GtkFileChooserAction action, GtkEntry *entry);
110 GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text);
112 void ui_add_document_sensitive(GtkWidget *widget);
114 void ui_widget_set_tooltip_text(GtkWidget *widget, const gchar *text);
116 GtkWidget *ui_image_menu_item_new(const gchar *stock_id, const gchar *label);
118 GtkWidget *ui_lookup_widget(GtkWidget *widget, const gchar *widget_name);
120 void ui_progress_bar_start(const gchar *text);
122 void ui_progress_bar_stop(void);
124 void ui_entry_add_clear_icon(GtkEntry *entry);
126 void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback callback);
128 void ui_menu_add_document_items_sorted(GtkMenu *menu, GeanyDocument *active,
129 GCallback callback, GCompareFunc sort_func);
131 void ui_widget_modify_font_from_string(GtkWidget *wid, const gchar *str);
133 gboolean ui_is_keyval_enter_or_return(guint keyval);
135 gint ui_get_gtk_settings_integer(const gchar *property_name, gint default_value);
137 void ui_combo_box_add_to_history(GtkComboBoxText *combo_entry,
138 const gchar *text, gint history_len);
140 const gchar *ui_lookup_stock_label(const gchar *stock_id);
142 void ui_tree_view_set_tooltip_text_column(GtkTreeView *tree_view, gint column);
145 #ifdef GEANY_PRIVATE
147 extern GeanyInterfacePrefs interface_prefs;
149 extern GeanyMainWidgets main_widgets;
152 /* User Interface settings not shown in the Prefs dialog. */
153 typedef struct UIPrefs
155 /* State of the main window when Geany was closed */
156 gint geometry[5]; /* 0:x, 1:y, 2:width, 3:height, flag for maximized state */
157 gboolean fullscreen;
158 gboolean sidebar_visible;
159 gint sidebar_page;
160 gboolean msgwindow_visible;
161 gboolean allow_always_save; /* if set, files can always be saved, even if unchanged */
162 gchar *statusbar_template;
163 gboolean new_document_after_close;
165 /* Menu-item related data */
166 GQueue *recent_queue;
167 GQueue *recent_projects_queue;
168 gchar *custom_date_format;
169 gchar **custom_commands;
170 gchar **custom_commands_labels;
172 UIPrefs;
174 extern UIPrefs ui_prefs;
177 /* Less commonly used widgets */
178 typedef struct UIWidgets
180 /* menu widgets */
181 GtkWidget *toolbar_menu;
182 GtkWidget *recent_files_menuitem;
183 GtkWidget *recent_files_menu_menubar;
184 GtkWidget *print_page_setup;
185 GtkWidget *recent_projects_menuitem;
186 GtkWidget *recent_projects_menu_menubar;
188 /* dialogs */
189 GtkWidget *open_colorsel;
190 GtkWidget *open_fontsel;
191 GtkWidget *prefs_dialog;
193 /* other widgets not needed in GeanyMainWidgets */
194 GtkWidget *statusbar; /* use ui_set_statusbar() to set */
196 UIWidgets;
198 extern UIWidgets ui_widgets;
201 /* The following block of types & functions are more generic and closely related to
202 * certain GTK+ widgets. */
204 typedef struct GeanyAutoSeparator
206 GtkWidget *widget; /* e.g. GtkSeparatorToolItem, GtkSeparatorMenuItem */
207 gint show_count; /* visible items, set to zero initially */
208 gint item_count; /* total items, set to zero initially */
210 GeanyAutoSeparator;
213 typedef enum
215 GEANY_EDITOR_SHOW_MARKERS_MARGIN,
216 GEANY_EDITOR_SHOW_LINE_NUMBERS,
217 GEANY_EDITOR_SHOW_WHITE_SPACE,
218 GEANY_EDITOR_SHOW_INDENTATION_GUIDES,
219 GEANY_EDITOR_SHOW_LINE_ENDINGS
221 GeanyUIEditorFeatures;
224 void ui_widget_show_hide(GtkWidget *widget, gboolean show);
226 void ui_menu_sort_by_label(GtkMenu *menu);
228 gchar *ui_menu_item_get_text(GtkMenuItem *menu_item);
230 void ui_dialog_set_primary_button_order(GtkDialog *dialog, gint response, ...);
232 void ui_hbutton_box_copy_layout(GtkButtonBox *master, GtkButtonBox *copy);
234 void ui_combo_box_prepend_text_once(GtkComboBoxText *combo, const gchar *text);
236 void ui_setup_open_button_callback(GtkWidget *open_btn, const gchar *title,
237 GtkFileChooserAction action, GtkEntry *entry);
239 void ui_auto_separator_add_ref(GeanyAutoSeparator *autosep, GtkWidget *item);
241 gpointer ui_builder_get_object (const gchar *name);
243 /* Compatibility functions */
244 GtkWidget *create_edit_menu1(void);
245 GtkWidget *create_prefs_dialog(void);
246 GtkWidget *create_project_dialog(void);
247 GtkWidget *create_toolbar_popup_menu1(void);
248 GtkWidget *create_window1(void);
250 void ui_widget_set_sensitive(GtkWidget *widget, gboolean set);
252 void ui_entry_add_activate_backward_signal(GtkEntry *entry);
254 void ui_editable_insert_text_callback(GtkEditable *editable, gchar *new_text,
255 gint new_text_len, gint *position, gpointer data);
257 GtkWidget *ui_label_new_bold(const gchar *text);
259 void ui_label_set_markup(GtkLabel *label, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
261 /* End of general widget functions */
263 void ui_init_builder(void);
265 void ui_init(void);
267 void ui_init_prefs(void);
269 void ui_finalize_builder(void);
271 void ui_init_toolbar_widgets(void);
273 void ui_init_stock_items(void);
275 void ui_add_config_file_menu_item(const gchar *real_path, const gchar *label,
276 GtkContainer *parent);
278 void ui_update_statusbar(GeanyDocument *doc, gint pos);
281 /* This sets the window title according to the current filename. */
282 void ui_set_window_title(GeanyDocument *doc);
284 void ui_set_editor_font(const gchar *font_name);
286 void ui_set_fullscreen(void);
289 void ui_update_popup_reundo_items(GeanyDocument *doc);
291 void ui_update_popup_copy_items(GeanyDocument *doc);
293 void ui_update_popup_goto_items(gboolean enable);
296 void ui_update_menu_copy_items(GeanyDocument *doc);
298 void ui_update_insert_include_item(GeanyDocument *doc, gint item);
300 void ui_update_fold_items(void);
303 void ui_create_insert_menu_items(void);
305 void ui_create_insert_date_menu_items(void);
308 void ui_save_buttons_toggle(gboolean enable);
310 void ui_document_buttons_update(void);
313 void ui_sidebar_show_hide(void);
315 void ui_document_show_hide(GeanyDocument *doc);
317 void ui_set_search_entry_background(GtkWidget *widget, gboolean success);
320 void ui_create_recent_menus(void);
322 void ui_add_recent_document(GeanyDocument *doc);
324 void ui_add_recent_project_file(const gchar *utf8_filename);
326 void ui_update_recent_project_menu(void);
329 void ui_update_tab_status(GeanyDocument *doc);
332 typedef gboolean TVMatchCallback(gboolean);
334 gboolean ui_tree_view_find_next(GtkTreeView *treeview, TVMatchCallback cb);
336 gboolean ui_tree_view_find_previous(GtkTreeView *treeview, TVMatchCallback cb);
338 gboolean ui_tree_model_iter_any_next(GtkTreeModel *model, GtkTreeIter *iter, gboolean down);
340 void ui_statusbar_showhide(gboolean state);
342 void ui_toggle_editor_features(GeanyUIEditorFeatures feature);
344 void ui_update_view_editor_menu_items(void);
346 void ui_swap_sidebar_pos(void);
348 GIcon *ui_get_mime_icon(const gchar *mime_type);
350 void ui_focus_current_document(void);
352 GtkWidget *ui_create_encodings_combo_box(gboolean has_detect, gint default_enc);
354 gint ui_encodings_combo_box_get_active_encoding(GtkComboBox *combo);
356 gboolean ui_encodings_combo_box_set_active_encoding(GtkComboBox *combo, gint enc);
358 #endif /* GEANY_PRIVATE */
360 G_END_DECLS
362 #endif /* GEANY_UI_UTILS_H */