src/ui_utils.h

   1 /*
   2  *      ui_utils.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   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>
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 #ifndef GEANY_UI_UTILS_H
  23 #define GEANY_UI_UTILS_H 1
  24
  25 #include "document.h"
  26
  27 #include "gtkcompat.h"
  28
  29 G_BEGIN_DECLS
  30
  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().
  36  *
  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);
  42
  43
  44 /** Interface preferences */
  45 typedef struct GeanyInterfacePrefs
  46 {
  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 */
  71         gint                    symbols_sort_mode;                      /**< symbol list sorting mode */
  72 }
  73 GeanyInterfacePrefs;
  74
  75
  76 /** Important widgets in the main window.
  77  * Accessed by @c geany->main_widgets. */
  78 typedef struct GeanyMainWidgets
  79 {
  80         GtkWidget       *window;                        /**< Main window. */
  81         GtkWidget       *toolbar;                       /**< Main toolbar. */
  82         GtkWidget       *sidebar_notebook;      /**< Sidebar notebook. */
  83         GtkWidget       *notebook;                      /**< Document notebook. */
  84         GtkWidget       *editor_menu;           /**< Popup editor menu. */
  85         GtkWidget       *tools_menu;            /**< Most plugins add menu items to the Tools menu. */
  86         /** Progress bar widget in the status bar to show progress of various actions.
  87          * See ui_progress_bar_start() for details. */
  88         GtkWidget       *progressbar;
  89         GtkWidget       *message_window_notebook; /**< Message Window notebook. */
  90         /** Plugins modifying the project can add their items to the Project menu. */
  91         GtkWidget       *project_menu;
  92 }
  93 GeanyMainWidgets;
  94
  95
  96 #define GEANY_STOCK_SAVE_ALL "geany-save-all"
  97 #define GEANY_STOCK_CLOSE_ALL "geany-close-all"
  98 #define GEANY_STOCK_BUILD "geany-build"
  99
 100
 101 GtkWidget *ui_dialog_vbox_new(GtkDialog *dialog);
 102
 103 GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alignment);
 104
 105 void ui_set_statusbar(gboolean log, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 106
 107 void ui_table_add_row(GtkTable *table, gint row, ...) G_GNUC_NULL_TERMINATED;
 108
 109 GtkWidget *ui_path_box_new(const gchar *title, GtkFileChooserAction action, GtkEntry *entry);
 110
 111 GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text);
 112
 113 void ui_add_document_sensitive(GtkWidget *widget);
 114
 115 void ui_widget_set_tooltip_text(GtkWidget *widget, const gchar *text);
 116
 117 GtkWidget *ui_image_menu_item_new(const gchar *stock_id, const gchar *label);
 118
 119 GtkWidget *ui_lookup_widget(GtkWidget *widget, const gchar *widget_name);
 120
 121 void ui_progress_bar_start(const gchar *text);
 122
 123 void ui_progress_bar_stop(void);
 124
 125 void ui_entry_add_clear_icon(GtkEntry *entry);
 126
 127 void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback callback);
 128
 129 void ui_menu_add_document_items_sorted(GtkMenu *menu, GeanyDocument *active,
 130                 GCallback callback, GCompareFunc sort_func);
 131
 132 void ui_widget_modify_font_from_string(GtkWidget *wid, const gchar *str);
 133
 134 gboolean ui_is_keyval_enter_or_return(guint keyval);
 135
 136 gint ui_get_gtk_settings_integer(const gchar *property_name, gint default_value);
 137
 138 void ui_combo_box_add_to_history(GtkComboBoxText *combo_entry,
 139                 const gchar *text, gint history_len);
 140
 141 const gchar *ui_lookup_stock_label(const gchar *stock_id);
 142
 143 void ui_tree_view_set_tooltip_text_column(GtkTreeView *tree_view, gint column);
 144
 145
 146 #ifdef GEANY_PRIVATE
 147
 148 extern GeanyInterfacePrefs interface_prefs;
 149
 150 extern GeanyMainWidgets main_widgets;
 151
 152
 153 /* User Interface settings not shown in the Prefs dialog. */
 154 typedef struct UIPrefs
 155 {
 156         /* State of the main window when Geany was closed */
 157         gint            geometry[5];    /* 0:x, 1:y, 2:width, 3:height, flag for maximized state */
 158         gboolean        fullscreen;
 159         gboolean        sidebar_visible;
 160         gint            sidebar_page;
 161         gboolean        msgwindow_visible;
 162         gboolean        allow_always_save; /* if set, files can always be saved, even if unchanged */
 163         gchar           *statusbar_template;
 164         gboolean        new_document_after_close;
 165
 166         /* Menu-item related data */
 167         GQueue          *recent_queue;
 168         GQueue          *recent_projects_queue;
 169         gchar           *custom_date_format;
 170         gchar           **custom_commands;
 171         gchar           **custom_commands_labels;
 172 }
 173 UIPrefs;
 174
 175 extern UIPrefs ui_prefs;
 176
 177
 178 /* Less commonly used widgets */
 179 typedef struct UIWidgets
 180 {
 181         /* menu widgets */
 182         GtkWidget       *toolbar_menu;
 183         GtkWidget       *recent_files_menuitem;
 184         GtkWidget       *recent_files_menu_menubar;
 185         GtkWidget       *print_page_setup;
 186         GtkWidget       *recent_projects_menuitem;
 187         GtkWidget       *recent_projects_menu_menubar;
 188         GtkWidget       *config_files_filetype_menu;
 189
 190         /* dialogs */
 191         GtkWidget       *open_colorsel;
 192         GtkWidget       *open_fontsel;
 193         GtkWidget       *prefs_dialog;
 194
 195         /* other widgets not needed in GeanyMainWidgets */
 196         GtkWidget       *statusbar;                     /* use ui_set_statusbar() to set */
 197 }
 198 UIWidgets;
 199
 200 extern UIWidgets ui_widgets;
 201
 202
 203 /* The following block of types & functions are more generic and closely related to
 204  * certain GTK+ widgets. */
 205
 206 typedef struct GeanyAutoSeparator
 207 {
 208         GtkWidget       *widget;        /* e.g. GtkSeparatorToolItem, GtkSeparatorMenuItem */
 209         gint            show_count;     /* visible items, set to zero initially */
 210         gint            item_count;     /* total items, set to zero initially */
 211 }
 212 GeanyAutoSeparator;
 213
 214
 215 typedef enum
 216 {
 217         GEANY_EDITOR_SHOW_MARKERS_MARGIN,
 218         GEANY_EDITOR_SHOW_LINE_NUMBERS,
 219         GEANY_EDITOR_SHOW_WHITE_SPACE,
 220         GEANY_EDITOR_SHOW_INDENTATION_GUIDES,
 221         GEANY_EDITOR_SHOW_LINE_ENDINGS
 222 }
 223 GeanyUIEditorFeatures;
 224
 225
 226 void ui_widget_show_hide(GtkWidget *widget, gboolean show);
 227
 228 gchar *ui_menu_item_get_text(GtkMenuItem *menu_item);
 229
 230 void ui_dialog_set_primary_button_order(GtkDialog *dialog, gint response, ...);
 231
 232 void ui_hbutton_box_copy_layout(GtkButtonBox *master, GtkButtonBox *copy);
 233
 234 void ui_combo_box_prepend_text_once(GtkComboBoxText *combo, const gchar *text);
 235
 236 void ui_setup_open_button_callback(GtkWidget *open_btn, const gchar *title,
 237                 GtkFileChooserAction action, GtkEntry *entry);
 238
 239 void ui_auto_separator_add_ref(GeanyAutoSeparator *autosep, GtkWidget *item);
 240
 241 gpointer ui_builder_get_object (const gchar *name);
 242
 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);
 249
 250 void ui_widget_set_sensitive(GtkWidget *widget, gboolean set);
 251
 252 void ui_entry_add_activate_backward_signal(GtkEntry *entry);
 253
 254 void ui_editable_insert_text_callback(GtkEditable *editable, gchar *new_text,
 255                                                                           gint new_text_len, gint *position, gpointer data);
 256
 257 GtkWidget *ui_label_new_bold(const gchar *text);
 258
 259 void ui_label_set_markup(GtkLabel *label, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
 260
 261 /* End of general widget functions */
 262
 263 void ui_init_builder(void);
 264
 265 void ui_init(void);
 266
 267 void ui_init_prefs(void);
 268
 269 void ui_finalize_builder(void);
 270
 271 void ui_init_toolbar_widgets(void);
 272
 273 void ui_init_stock_items(void);
 274
 275 void ui_add_config_file_menu_item(const gchar *real_path, const gchar *label,
 276                 GtkContainer *parent);
 277
 278 void ui_update_statusbar(GeanyDocument *doc, gint pos);
 279
 280
 281 /* This sets the window title according to the current filename. */
 282 void ui_set_window_title(GeanyDocument *doc);
 283
 284 void ui_set_editor_font(const gchar *font_name);
 285
 286 void ui_set_fullscreen(void);
 287
 288
 289 void ui_update_popup_reundo_items(GeanyDocument *doc);
 290
 291 void ui_update_popup_copy_items(GeanyDocument *doc);
 292
 293 void ui_update_popup_goto_items(gboolean enable);
 294
 295
 296 void ui_update_menu_copy_items(GeanyDocument *doc);
 297
 298 void ui_update_insert_include_item(GeanyDocument *doc, gint item);
 299
 300 void ui_update_fold_items(void);
 301
 302
 303 void ui_create_insert_menu_items(void);
 304
 305 void ui_create_insert_date_menu_items(void);
 306
 307
 308 void ui_save_buttons_toggle(gboolean enable);
 309
 310 void ui_document_buttons_update(void);
 311
 312
 313 void ui_sidebar_show_hide(void);
 314
 315 void ui_document_show_hide(GeanyDocument *doc);
 316
 317 void ui_set_search_entry_background(GtkWidget *widget, gboolean success);
 318
 319
 320 void ui_create_recent_menus(void);
 321
 322 void ui_add_recent_document(GeanyDocument *doc);
 323
 324 void ui_add_recent_project_file(const gchar *utf8_filename);
 325
 326 void ui_update_recent_project_menu(void);
 327
 328
 329 void ui_update_tab_status(GeanyDocument *doc);
 330
 331
 332 typedef gboolean TVMatchCallback(gboolean);
 333
 334 gboolean ui_tree_view_find_next(GtkTreeView *treeview, TVMatchCallback cb);
 335
 336 gboolean ui_tree_view_find_previous(GtkTreeView *treeview, TVMatchCallback cb);
 337
 338 gboolean ui_tree_model_iter_any_next(GtkTreeModel *model, GtkTreeIter *iter, gboolean down);
 339
 340 void ui_statusbar_showhide(gboolean state);
 341
 342 void ui_toggle_editor_features(GeanyUIEditorFeatures feature);
 343
 344 void ui_update_view_editor_menu_items(void);
 345
 346 void ui_swap_sidebar_pos(void);
 347
 348 GIcon *ui_get_mime_icon(const gchar *mime_type);
 349
 350 void ui_focus_current_document(void);
 351
 352 GtkWidget *ui_create_encodings_combo_box(gboolean has_detect, gint default_enc);
 353
 354 gint ui_encodings_combo_box_get_active_encoding(GtkComboBox *combo);
 355
 356 gboolean ui_encodings_combo_box_set_active_encoding(GtkComboBox *combo, gint enc);
 357
 358 #endif /* GEANY_PRIVATE */
 359
 360 G_END_DECLS
 361
 362 #endif /* GEANY_UI_UTILS_H */