src/ui_utils.h

   1 /*
   2  *      ui_utils.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2006-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2011 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
  26 /** Sets a name to lookup @a widget from @a owner.
  27  * @param owner Usually a window, dialog or popup menu.
  28  * @param widget Widget.
  29  * @param widget_name Name.
  30  * @see ui_lookup_widget().
  31  *
  32  *  @since 0.16
  33  **/
  34 #define ui_hookup_widget(owner, widget, widget_name) \
  35         interface_add_object(G_OBJECT(widget), widget_name)
  36
  37
  38 /** Interface preferences */
  39 typedef struct GeanyInterfacePrefs
  40 {
  41         gboolean                sidebar_symbol_visible;         /**< whether the symbol sidebar is visible */
  42         gboolean                sidebar_openfiles_visible;      /**< whether the open file list is visible */
  43         gchar                   *editor_font;                           /**< editor font */
  44         gchar                   *tagbar_font;                           /**< symbol sidebar font */
  45         gchar                   *msgwin_font;                           /**< message window font */
  46         gboolean                show_notebook_tabs;                     /**< whether editor tabs are visible */
  47         gint                    tab_pos_editor;                         /**< positions of editor's tabs */
  48         gint                    tab_pos_msgwin;                         /**< positions of message window's tabs */
  49         gint                    tab_pos_sidebar;                        /**< positions of sidebar's tabs */
  50         gboolean                statusbar_visible;                      /**< whether the status bar is visible */
  51         gboolean                show_symbol_list_expanders;     /**< whether to show expanders in the symbol list */
  52         /** whether a double click on notebook tabs hides all other windows */
  53         gboolean                notebook_double_click_hides_widgets;
  54         gboolean                highlighting_invert_all;        /**< whether highlighting colors are inverted */
  55         gint                    sidebar_pos;                            /**< position of the sidebar (left or right) */
  56         gboolean                msgwin_status_visible;          /**< whether message window's status tab is visible */
  57         gboolean                msgwin_compiler_visible;        /**< whether message window's compiler tab is visible */
  58         gboolean                msgwin_messages_visible;        /**< whether message window's messages tab is visible */
  59         gboolean                msgwin_scribble_visible;        /**< whether message window's scribble tab is visible */
  60         /** whether to use native Windows' dialogs (only used on Windows) */
  61         gboolean                use_native_windows_dialogs;
  62         /** whether compiler messages window is automatically scrolled to show new messages */
  63         gboolean                compiler_tab_autoscroll;
  64 }
  65 GeanyInterfacePrefs;
  66
  67 extern GeanyInterfacePrefs interface_prefs;
  68
  69
  70 /** Important widgets in the main window.
  71  * Accessed by @c geany->main_widgets. */
  72 typedef struct GeanyMainWidgets
  73 {
  74         GtkWidget       *window;                        /**< Main window. */
  75         GtkWidget       *toolbar;                       /**< Main toolbar. */
  76         GtkWidget       *sidebar_notebook;      /**< Sidebar notebook. */
  77         GtkWidget       *notebook;                      /**< Document notebook. */
  78         GtkWidget       *editor_menu;           /**< Popup editor menu. */
  79         GtkWidget       *tools_menu;            /**< Most plugins add menu items to the Tools menu. */
  80         /** Progress bar widget in the status bar to show progress of various actions.
  81          * See ui_progress_bar_start() for details. */
  82         GtkWidget       *progressbar;
  83         GtkWidget       *message_window_notebook; /**< Message Window notebook. */
  84         /** Plugins modifying the project can add their items to the Project menu. */
  85         GtkWidget       *project_menu;
  86 }
  87 GeanyMainWidgets;
  88
  89 extern GeanyMainWidgets main_widgets;
  90
  91
  92 /* User Interface settings not shown in the Prefs dialog. */
  93 typedef struct UIPrefs
  94 {
  95         /* State of the main window when Geany was closed */
  96         gint            geometry[5];    /* 0:x, 1:y, 2:width, 3:height, flag for maximized state */
  97         gboolean        fullscreen;
  98         gboolean        sidebar_visible;
  99         gint            sidebar_page;
 100         gboolean        msgwindow_visible;
 101         gboolean        allow_always_save; /* if set, files can always be saved, even if unchanged */
 102         gboolean        new_document_after_close;
 103
 104         /* Menu-item related data */
 105         GQueue          *recent_queue;
 106         GQueue          *recent_projects_queue;
 107         gchar           *custom_date_format;
 108         gchar           **custom_commands;
 109 }
 110 UIPrefs;
 111
 112 extern UIPrefs ui_prefs;
 113
 114
 115 /* Less commonly used widgets */
 116 typedef struct UIWidgets
 117 {
 118         /* menu widgets */
 119         GtkWidget       *toolbar_menu;
 120         GtkWidget       *recent_files_menuitem;
 121         GtkWidget       *recent_files_menu_menubar;
 122         GtkWidget       *print_page_setup;
 123         GtkWidget       *recent_projects_menuitem;
 124         GtkWidget       *recent_projects_menu_menubar;
 125
 126         /* dialogs */
 127         GtkWidget       *open_colorsel;
 128         GtkWidget       *open_fontsel;
 129         GtkWidget       *prefs_dialog;
 130
 131         /* other widgets not needed in GeanyMainWidgets */
 132         GtkWidget       *statusbar;                     /* use ui_set_statusbar() to set */
 133 }
 134 UIWidgets;
 135
 136 extern UIWidgets ui_widgets;
 137
 138
 139 /* The following block of types & functions are more generic and closely related to
 140  * certain GTK+ widgets. */
 141
 142 typedef struct GeanyAutoSeparator
 143 {
 144         GtkWidget       *widget;        /* e.g. GtkSeparatorToolItem, GtkSeparatorMenuItem */
 145         gint            ref_count;      /* set to zero initially */
 146 }
 147 GeanyAutoSeparator;
 148
 149
 150 typedef enum
 151 {
 152         GEANY_EDITOR_SHOW_MARKERS_MARGIN,
 153         GEANY_EDITOR_SHOW_LINE_NUMBERS,
 154         GEANY_EDITOR_SHOW_WHITE_SPACE,
 155         GEANY_EDITOR_SHOW_INDENTATION_GUIDES,
 156         GEANY_EDITOR_SHOW_LINE_ENDINGS
 157 }
 158 GeanyUIEditorFeatures;
 159
 160
 161 #define GEANY_STOCK_SAVE_ALL "geany-save-all"
 162 #define GEANY_STOCK_CLOSE_ALL "geany-close-all"
 163 #define GEANY_STOCK_BUILD "geany-build"
 164
 165 enum
 166 {
 167         GEANY_IMAGE_LOGO,
 168         GEANY_IMAGE_SAVE_ALL,
 169         GEANY_IMAGE_CLOSE_ALL,
 170         GEANY_IMAGE_BUILD
 171 };
 172
 173
 174 void ui_widget_show_hide(GtkWidget *widget, gboolean show);
 175
 176 void ui_widget_modify_font_from_string(GtkWidget *wid, const gchar *str);
 177
 178 void ui_menu_sort_by_label(GtkMenu *menu);
 179
 180 gchar *ui_menu_item_get_text(GtkMenuItem *menu_item);
 181
 182 GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alignment);
 183
 184 GtkWidget *ui_dialog_vbox_new(GtkDialog *dialog);
 185
 186 GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text);
 187
 188 GtkWidget *ui_image_menu_item_new(const gchar *stock_id, const gchar *label);
 189
 190 void ui_hbutton_box_copy_layout(GtkButtonBox *master, GtkButtonBox *copy);
 191
 192 void ui_combo_box_add_to_history(GtkComboBoxEntry *combo_entry,
 193                 const gchar *text, gint history_len);
 194
 195 void ui_combo_box_prepend_text_once(GtkComboBox *combo, const gchar *text);
 196
 197 GtkWidget *ui_path_box_new(const gchar *title, GtkFileChooserAction action, GtkEntry *entry);
 198
 199 void ui_setup_open_button_callback(GtkWidget *open_btn, const gchar *title,
 200                 GtkFileChooserAction action, GtkEntry *entry);
 201
 202 void ui_table_add_row(GtkTable *table, gint row, ...) G_GNUC_NULL_TERMINATED;
 203
 204 void ui_auto_separator_add_ref(GeanyAutoSeparator *autosep, GtkWidget *item);
 205
 206 void ui_widget_set_tooltip_text(GtkWidget *widget, const gchar *text);
 207
 208 GtkWidget *ui_lookup_widget(GtkWidget *widget, const gchar *widget_name);
 209
 210 void ui_widget_set_sensitive(GtkWidget *widget, gboolean set);
 211
 212 void ui_entry_add_clear_icon(GtkEntry *entry);
 213
 214 void ui_entry_add_activate_backward_signal(GtkEntry *entry);
 215
 216 void ui_editable_insert_text_callback(GtkEditable *editable, gchar *new_text,
 217                                                                           gint new_text_len, gint *position, gpointer data);
 218
 219 GtkWidget *ui_label_new_bold(const gchar *text);
 220
 221 void ui_label_set_markup(GtkLabel *label, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
 222
 223 /* End of general widget functions */
 224
 225
 226 void ui_init(void);
 227
 228 void ui_init_prefs(void);
 229
 230 void ui_finalize(void);
 231
 232 void ui_init_toolbar_widgets(void);
 233
 234 void ui_init_stock_items(void);
 235
 236 void ui_add_config_file_menu_item(const gchar *real_path, const gchar *label,
 237                 GtkContainer *parent);
 238
 239 void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback callback);
 240
 241 void ui_menu_add_document_items_sorted(GtkMenu *menu, GeanyDocument *active,
 242                 GCallback callback, GCompareFunc sort_func);
 243
 244 void ui_set_statusbar(gboolean log, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 245
 246 void ui_update_statusbar(GeanyDocument *doc, gint pos);
 247
 248
 249 /* This sets the window title according to the current filename. */
 250 void ui_set_window_title(GeanyDocument *doc);
 251
 252 void ui_set_editor_font(const gchar *font_name);
 253
 254 void ui_set_fullscreen(void);
 255
 256
 257 void ui_update_popup_reundo_items(GeanyDocument *doc);
 258
 259 void ui_update_popup_copy_items(GeanyDocument *doc);
 260
 261 void ui_update_popup_goto_items(gboolean enable);
 262
 263
 264 void ui_update_menu_copy_items(GeanyDocument *doc);
 265
 266 void ui_update_insert_include_item(GeanyDocument *doc, gint item);
 267
 268 void ui_update_fold_items(void);
 269
 270
 271 void ui_create_insert_menu_items(void);
 272
 273 void ui_create_insert_date_menu_items(void);
 274
 275
 276 void ui_save_buttons_toggle(gboolean enable);
 277
 278 void ui_document_buttons_update(void);
 279
 280
 281 void ui_sidebar_show_hide(void);
 282
 283 void ui_document_show_hide(GeanyDocument *doc);
 284
 285 void ui_set_search_entry_background(GtkWidget *widget, gboolean success);
 286
 287
 288 GdkPixbuf *ui_new_pixbuf_from_inline(gint img);
 289
 290 GtkWidget *ui_new_image_from_inline(gint img);
 291
 292
 293 void ui_create_recent_menus(void);
 294
 295 void ui_add_recent_file(const gchar *utf8_filename);
 296
 297 void ui_add_recent_project_file(const gchar *utf8_filename);
 298
 299
 300 void ui_update_tab_status(GeanyDocument *doc);
 301
 302
 303 typedef gboolean TVMatchCallback(gboolean);
 304
 305 gboolean ui_tree_view_find_next(GtkTreeView *treeview, TVMatchCallback cb);
 306
 307 gboolean ui_tree_view_find_previous(GtkTreeView *treeview, TVMatchCallback cb);
 308
 309
 310 void ui_statusbar_showhide(gboolean state);
 311
 312 void ui_add_document_sensitive(GtkWidget *widget);
 313
 314 void ui_toggle_editor_features(GeanyUIEditorFeatures feature);
 315
 316 void ui_update_view_editor_menu_items(void);
 317
 318 void ui_progress_bar_start(const gchar *text);
 319
 320 void ui_progress_bar_stop(void);
 321
 322 void ui_swap_sidebar_pos(void);
 323
 324 gboolean ui_is_keyval_enter_or_return(guint keyval);
 325
 326 gint ui_get_gtk_settings_integer(const gchar *property_name, gint default_value);
 327
 328 GdkPixbuf *ui_get_mime_icon(const gchar *mime_type, GtkIconSize size);
 329
 330 void ui_focus_current_document(void);
 331
 332
 333 #endif