src/ui_utils.h

   1 /*
   2  *      ui_utils.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2006 The Geany contributors
   5  *
   6  *      This program is free software; you can redistribute it and/or modify
   7  *      it under the terms of the GNU General Public License as published by
   8  *      the Free Software Foundation; either version 2 of the License, or
   9  *      (at your option) any later version.
  10  *
  11  *      This program is distributed in the hope that it will be useful,
  12  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *      GNU General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU General Public License
  17  *      along with this program; if not, write to the Free Software
  18  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef GEANY_UI_UTILS_H
  22 #define GEANY_UI_UTILS_H 1
  23
  24 #include "geany.h" /* for GEANY_DEPRECATED */
  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 void ui_set_statusbar(gboolean log, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 104
 105 void ui_table_add_row(GtkTable *table, gint row, ...) G_GNUC_NULL_TERMINATED;
 106
 107 GtkWidget *ui_path_box_new(const gchar *title, GtkFileChooserAction action, GtkEntry *entry);
 108
 109 GtkWidget *ui_button_new_with_image(const gchar *stock_id, const gchar *text);
 110
 111 void ui_add_document_sensitive(GtkWidget *widget);
 112
 113 GtkWidget *ui_image_menu_item_new(const gchar *stock_id, const gchar *label);
 114
 115 GtkWidget *ui_lookup_widget(GtkWidget *widget, const gchar *widget_name);
 116
 117 void ui_progress_bar_start(const gchar *text);
 118
 119 void ui_progress_bar_stop(void);
 120
 121 void ui_entry_add_clear_icon(GtkEntry *entry);
 122
 123 void ui_menu_add_document_items(GtkMenu *menu, GeanyDocument *active, GCallback callback);
 124
 125 void ui_menu_add_document_items_sorted(GtkMenu *menu, GeanyDocument *active,
 126                 GCallback callback, GCompareFunc sort_func);
 127
 128 void ui_widget_modify_font_from_string(GtkWidget *wid, const gchar *str);
 129
 130 gboolean ui_is_keyval_enter_or_return(guint keyval);
 131
 132 gint ui_get_gtk_settings_integer(const gchar *property_name, gint default_value);
 133
 134 void ui_combo_box_add_to_history(GtkComboBoxText *combo_entry,
 135                 const gchar *text, gint history_len);
 136
 137 const gchar *ui_lookup_stock_label(const gchar *stock_id);
 138
 139 void ui_tree_view_set_tooltip_text_column(GtkTreeView *tree_view, gint column);
 140
 141
 142 #ifndef GEANY_DISABLE_DEPRECATED
 143 GtkWidget *ui_frame_new_with_alignment(const gchar *label_text, GtkWidget **alignment) GEANY_DEPRECATED;
 144
 145 void ui_widget_set_tooltip_text(GtkWidget *widget, const gchar *text) GEANY_DEPRECATED_FOR(gtk_widget_set_tooltip_text);
 146 #endif  /* GEANY_DISABLE_DEPRECATED */
 147
 148
 149 #ifdef GEANY_PRIVATE
 150
 151 extern GeanyInterfacePrefs interface_prefs;
 152
 153 extern GeanyMainWidgets main_widgets;
 154
 155
 156 /* User Interface settings not shown in the Prefs dialog. */
 157 typedef struct UIPrefs
 158 {
 159         /* State of the main window when Geany was closed */
 160         gint            geometry[5];    /* 0:x, 1:y, 2:width, 3:height, flag for maximized state */
 161         gboolean        fullscreen;
 162         gboolean        sidebar_visible;
 163         gint            sidebar_page;
 164         gboolean        msgwindow_visible;
 165         gboolean        allow_always_save; /* if set, files can always be saved, even if unchanged */
 166         gchar           *statusbar_template;
 167         gboolean        new_document_after_close;
 168
 169         /* Menu-item related data */
 170         GQueue          *recent_queue;
 171         GQueue          *recent_projects_queue;
 172         gchar           *custom_date_format;
 173         gchar           **custom_commands;
 174         gchar           **custom_commands_labels;
 175 }
 176 UIPrefs;
 177
 178 extern UIPrefs ui_prefs;
 179
 180
 181 /* Less commonly used widgets */
 182 typedef struct UIWidgets
 183 {
 184         /* menu widgets */
 185         GtkWidget       *toolbar_menu;
 186         GtkWidget       *recent_files_menuitem;
 187         GtkWidget       *recent_files_menu_menubar;
 188         GtkWidget       *print_page_setup;
 189         GtkWidget       *recent_projects_menuitem;
 190         GtkWidget       *recent_projects_menu_menubar;
 191         GtkWidget       *config_files_filetype_menu;
 192
 193         /* dialogs */
 194         GtkWidget       *open_colorsel;
 195         GtkWidget       *open_fontsel;
 196         GtkWidget       *prefs_dialog;
 197
 198         /* other widgets not needed in GeanyMainWidgets */
 199         GtkWidget       *statusbar;                     /* use ui_set_statusbar() to set */
 200 }
 201 UIWidgets;
 202
 203 extern UIWidgets ui_widgets;
 204
 205
 206 /* The following block of types & functions are more generic and closely related to
 207  * certain GTK+ widgets. */
 208
 209 typedef struct GeanyAutoSeparator
 210 {
 211         GtkWidget       *widget;        /* e.g. GtkSeparatorToolItem, GtkSeparatorMenuItem */
 212         gint            show_count;     /* visible items, set to zero initially */
 213         gint            item_count;     /* total items, set to zero initially */
 214 }
 215 GeanyAutoSeparator;
 216
 217
 218 typedef enum
 219 {
 220         GEANY_EDITOR_SHOW_MARKERS_MARGIN,
 221         GEANY_EDITOR_SHOW_LINE_NUMBERS,
 222         GEANY_EDITOR_SHOW_WHITE_SPACE,
 223         GEANY_EDITOR_SHOW_INDENTATION_GUIDES,
 224         GEANY_EDITOR_SHOW_LINE_ENDINGS
 225 }
 226 GeanyUIEditorFeatures;
 227
 228
 229 void ui_widget_show_hide(GtkWidget *widget, gboolean show);
 230
 231 gchar *ui_menu_item_get_text(GtkMenuItem *menu_item);
 232
 233 void ui_dialog_set_primary_button_order(GtkDialog *dialog, gint response, ...);
 234
 235 void ui_hbutton_box_copy_layout(GtkButtonBox *master, GtkButtonBox *copy);
 236
 237 void ui_combo_box_prepend_text_once(GtkComboBoxText *combo, const gchar *text);
 238
 239 void ui_setup_open_button_callback(GtkWidget *open_btn, const gchar *title,
 240                 GtkFileChooserAction action, GtkEntry *entry);
 241
 242 void ui_auto_separator_add_ref(GeanyAutoSeparator *autosep, GtkWidget *item);
 243
 244 gpointer ui_builder_get_object (const gchar *name);
 245
 246 /* Compatibility functions */
 247 GtkWidget *create_edit_menu1(void);
 248 GtkWidget *create_prefs_dialog(void);
 249 GtkWidget *create_project_dialog(void);
 250 GtkWidget *create_toolbar_popup_menu1(void);
 251 GtkWidget *create_window1(void);
 252
 253 void ui_widget_set_sensitive(GtkWidget *widget, gboolean set);
 254
 255 void ui_entry_add_activate_backward_signal(GtkEntry *entry);
 256
 257 void ui_editable_insert_text_callback(GtkEditable *editable, gchar *new_text,
 258                                                                           gint new_text_len, gint *position, gpointer data);
 259
 260 GtkWidget *ui_label_new_bold(const gchar *text);
 261
 262 void ui_label_set_markup(GtkLabel *label, const gchar *format, ...) G_GNUC_PRINTF(2, 3);
 263
 264 /* End of general widget functions */
 265
 266 void ui_init_builder(void);
 267
 268 void ui_init(void);
 269
 270 void ui_init_prefs(void);
 271
 272 void ui_finalize_builder(void);
 273
 274 void ui_init_toolbar_widgets(void);
 275
 276 void ui_init_stock_items(void);
 277
 278 void ui_add_config_file_menu_item(const gchar *real_path, const gchar *label,
 279                 GtkContainer *parent);
 280
 281 void ui_update_statusbar(GeanyDocument *doc, gint pos);
 282
 283
 284 /* This sets the window title according to the current filename. */
 285 void ui_set_window_title(GeanyDocument *doc);
 286
 287 void ui_set_editor_font(const gchar *font_name);
 288
 289 void ui_set_fullscreen(void);
 290
 291
 292 void ui_update_popup_reundo_items(GeanyDocument *doc);
 293
 294 void ui_update_popup_copy_items(GeanyDocument *doc);
 295
 296 void ui_update_popup_goto_items(gboolean enable);
 297
 298
 299 void ui_menu_copy_items_set_sensitive(gboolean sensitive);
 300
 301 void ui_update_menu_copy_items(GeanyDocument *doc);
 302
 303 void ui_update_insert_include_item(GeanyDocument *doc, gint item);
 304
 305 void ui_update_fold_items(void);
 306
 307
 308 void ui_create_insert_menu_items(void);
 309
 310 void ui_create_insert_date_menu_items(void);
 311
 312
 313 void ui_save_buttons_toggle(gboolean enable);
 314
 315 void ui_document_buttons_update(void);
 316
 317
 318 void ui_sidebar_show_hide(void);
 319
 320 void ui_document_show_hide(GeanyDocument *doc);
 321
 322 void ui_set_search_entry_background(GtkWidget *widget, gboolean success);
 323
 324
 325 void ui_create_recent_menus(void);
 326
 327 void ui_add_recent_document(GeanyDocument *doc);
 328
 329 void ui_add_recent_project_file(const gchar *utf8_filename);
 330
 331 void ui_update_recent_project_menu(void);
 332
 333
 334 void ui_update_tab_status(GeanyDocument *doc);
 335
 336
 337 typedef gboolean TVMatchCallback(gboolean);
 338
 339 gboolean ui_tree_view_find_next(GtkTreeView *treeview, TVMatchCallback cb);
 340
 341 gboolean ui_tree_view_find_previous(GtkTreeView *treeview, TVMatchCallback cb);
 342
 343 gboolean ui_tree_model_iter_any_next(GtkTreeModel *model, GtkTreeIter *iter, gboolean down);
 344
 345 void ui_statusbar_showhide(gboolean state);
 346
 347 void ui_toggle_editor_features(GeanyUIEditorFeatures feature);
 348
 349 void ui_update_view_editor_menu_items(void);
 350
 351 void ui_swap_sidebar_pos(void);
 352
 353 GIcon *ui_get_mime_icon(const gchar *mime_type);
 354
 355 void ui_focus_current_document(void);
 356
 357 GtkWidget *ui_create_encodings_combo_box(gboolean has_detect, gint default_enc);
 358
 359 gint ui_encodings_combo_box_get_active_encoding(GtkComboBox *combo);
 360
 361 gboolean ui_encodings_combo_box_set_active_encoding(GtkComboBox *combo, gint enc);
 362
 363 #endif /* GEANY_PRIVATE */
 364
 365 G_END_DECLS
 366
 367 #endif /* GEANY_UI_UTILS_H */