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