src/gtk/gtkutils.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 Hiroyuki Yamamoto and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifndef __GTKUTILS_H__
  21 #define __GTKUTILS_H__
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include <glib.h>
  28 #include <gdk/gdk.h>
  29 #include <gtk/gtkmain.h>
  30 #include <gtk/gtkwidget.h>
  31 #include <gtk/gtkcontainer.h>
  32 #include <gtk/gtkeditable.h>
  33 #include <gtk/gtkctree.h>
  34 #include <gtk/gtkcombo.h>
  35 #include <gtk/gtktextview.h>
  36 #include <gtk/gtkitemfactory.h>
  37 #include <gtk/gtktreemodel.h>
  38 #include <stdlib.h>
  39 #if HAVE_WCHAR_H
  40 #  include <wchar.h>
  41 #endif
  42
  43 #ifdef MAEMO
  44 #include <hildon-widgets/hildon-program.h>
  45 #include <hildon-widgets/hildon-window.h>
  46 #include "main.h"
  47 #include <gtk/gtkmain.h>
  48 #endif
  49
  50 typedef struct _ComboButton     ComboButton;
  51
  52 struct _ComboButton
  53 {
  54         GtkWidget *arrow;
  55         GtkWidget *button;
  56         GtkWidget *menu;
  57         GtkItemFactory *factory;
  58         gpointer data;
  59 };
  60
  61 #define GTK_EVENTS_FLUSH() \
  62 { \
  63         while (gtk_events_pending()) \
  64                 gtk_main_iteration(); \
  65 }
  66
  67 #define PIXMAP_CREATE(widget, pixmap, mask, xpm_d) \
  68 { \
  69         if (!pixmap) { \
  70                 GtkStyle *style = gtk_widget_get_style(widget); \
  71                 pixmap = gdk_pixmap_create_from_xpm_d \
  72                         (widget->window, &mask, \
  73                          &style->bg[GTK_STATE_NORMAL], xpm_d); \
  74         } \
  75 }
  76
  77 #define PIXMAP_CREATE_FROM_FILE(widget, pixmap, mask, filename) \
  78 { \
  79         if (!pixmap) { \
  80                 GtkStyle *style = gtk_widget_get_style(widget); \
  81                 pixmap = gdk_pixmap_create_from_xpm \
  82                         (widget->window, &mask, \
  83                          &style->bg[GTK_STATE_NORMAL], filename); \
  84         } \
  85 }
  86
  87 #define GTK_WIDGET_PTR(wid)     (*(GtkWidget **)wid)
  88
  89 #define GTKUT_CTREE_NODE_SET_ROW_DATA(node, d) \
  90 { \
  91         GTK_CTREE_ROW(node)->row.data = d; \
  92 }
  93
  94 #define GTKUT_CTREE_NODE_GET_ROW_DATA(node) \
  95         (GTK_CTREE_ROW(node)->row.data)
  96
  97 #define GTKUT_CTREE_REFRESH(clist) \
  98         GTK_CLIST_GET_CLASS(clist)->refresh(clist)
  99
 100 gboolean gtkut_get_font_size            (GtkWidget      *widget,
 101                                          gint           *width,
 102                                          gint           *height);
 103
 104 void gtkut_convert_int_to_gdk_color     (gint            rgbvalue,
 105                                          GdkColor       *color);
 106
 107 void gtkut_stock_button_add_help(GtkWidget *bbox, GtkWidget **help_btn);
 108
 109 void gtkut_stock_button_set_create_with_help(GtkWidget **bbox,
 110                 GtkWidget **help_button,
 111                 GtkWidget **button1, const gchar *label1,
 112                 GtkWidget **button2, const gchar *label2,
 113                 GtkWidget **button3, const gchar *label3);
 114
 115 void gtkut_stock_button_set_create      (GtkWidget      **bbox,
 116                                          GtkWidget      **button1,
 117                                          const gchar     *label1,
 118                                          GtkWidget      **button2,
 119                                          const gchar     *label2,
 120                                          GtkWidget      **button3,
 121                                          const gchar     *label3);
 122
 123 void gtkut_stock_with_text_button_set_create(GtkWidget **bbox,
 124                                    GtkWidget **button1, const gchar *label1, const gchar *text1,
 125                                    GtkWidget **button2, const gchar *label2, const gchar *text2,
 126                                    GtkWidget **button3, const gchar *label3, const gchar *text3);
 127
 128 ComboButton *gtkut_combo_button_create  (GtkWidget              *button,
 129                                          GtkItemFactoryEntry    *entries,
 130                                          gint                    n_entries,
 131                                          const gchar            *path,
 132                                          gpointer                data);
 133
 134 void gtkut_ctree_node_move_if_on_the_edge
 135                                         (GtkCTree       *ctree,
 136                                          GtkCTreeNode   *node,
 137                                          gint            _row);
 138 gint gtkut_ctree_get_nth_from_node      (GtkCTree       *ctree,
 139                                          GtkCTreeNode   *node);
 140 GtkCTreeNode *gtkut_ctree_node_next     (GtkCTree       *ctree,
 141                                          GtkCTreeNode   *node);
 142 GtkCTreeNode *gtkut_ctree_node_prev     (GtkCTree       *ctree,
 143                                          GtkCTreeNode   *node);
 144 gboolean gtkut_ctree_node_is_selected   (GtkCTree       *ctree,
 145                                          GtkCTreeNode   *node);
 146 GtkCTreeNode *gtkut_ctree_find_collapsed_parent
 147                                         (GtkCTree       *ctree,
 148                                          GtkCTreeNode   *node);
 149 void gtkut_ctree_expand_parent_all      (GtkCTree       *ctree,
 150                                          GtkCTreeNode   *node);
 151 gboolean gtkut_ctree_node_is_parent     (GtkCTreeNode   *parent,
 152                                          GtkCTreeNode   *node);
 153 void gtkut_ctree_set_focus_row          (GtkCTree       *ctree,
 154                                          GtkCTreeNode   *node);
 155
 156 void gtkut_clist_set_focus_row          (GtkCList       *clist,
 157                                          gint            row);
 158
 159 void gtkut_combo_set_items              (GtkCombo       *combo,
 160                                          const gchar    *str1, ...);
 161
 162 gchar *gtkut_editable_get_selection     (GtkEditable    *editable);
 163 void gtkut_editable_disable_im          (GtkEditable    *editable);
 164
 165 void gtkut_container_remove             (GtkContainer   *container,
 166                                          GtkWidget      *widget);
 167
 168 gboolean gtkut_text_buffer_match_string (GtkTextBuffer          *buffer,
 169                                          const GtkTextIter      *iter,
 170                                          gunichar               *wcs,
 171                                          gint                    len,
 172                                          gboolean                case_sens);
 173 gboolean gtkut_text_buffer_find         (GtkTextBuffer          *buffer,
 174                                          const GtkTextIter      *iter,
 175                                          const gchar            *str,
 176                                          gboolean                case_sens,
 177                                          GtkTextIter            *match_pos);
 178 gboolean gtkut_text_buffer_find_backward(GtkTextBuffer          *buffer,
 179                                          const GtkTextIter      *iter,
 180                                          const gchar            *str,
 181                                          gboolean                case_sens,
 182                                          GtkTextIter            *match_pos);
 183
 184 gchar *gtkut_text_view_get_selection    (GtkTextView    *textview);
 185 void gtkut_text_view_set_position               (GtkTextView *text, gint pos);
 186 gboolean gtkut_text_view_search_string  (GtkTextView *text, const gchar *str,
 187                                         gboolean case_sens);
 188 gboolean gtkut_text_view_search_string_backward (GtkTextView *text, const gchar *str,
 189                                         gboolean case_sens);
 190
 191 GtkWidget *label_window_create(const gchar *str);
 192 void label_window_destroy(GtkWidget *widget);
 193
 194 void gtkut_window_popup                 (GtkWidget      *window);
 195 GtkWidget *gtkut_window_new             (GtkWindowType   type,
 196                                          const gchar    *class);
 197
 198
 199 void gtkut_widget_get_uposition         (GtkWidget      *widget,
 200                                          gint           *px,
 201                                          gint           *py);
 202 void gtkut_widget_draw_now              (GtkWidget      *widget);
 203 void gtkut_widget_init                  (void);
 204
 205 void gtkut_widget_set_app_icon          (GtkWidget      *widget);
 206 void gtkut_widget_set_composer_icon     (GtkWidget      *widget);
 207
 208 GtkWidget *gtkut_account_menu_new       (GList                  *ac_list,
 209                                          GCallback               callback,
 210                                          gpointer                data);
 211
 212 void gtkut_set_widget_bgcolor_rgb       (GtkWidget      *widget,
 213                                          guint           rgbvalue);
 214
 215 void gtkut_widget_set_small_font_size(GtkWidget *widget);
 216 GtkWidget *gtkut_get_focused_child      (GtkContainer   *parent);
 217
 218 GtkWidget *gtkut_get_browse_file_btn(const gchar *label);
 219 GtkWidget *gtkut_get_browse_directory_btn(const gchar *label);
 220 GtkWidget *gtkut_get_replace_btn(const gchar *label);
 221 GtkWidget *gtkut_get_options_frame(GtkWidget *box, GtkWidget **frame, const gchar *frame_label);
 222 #if HAVE_LIBCOMPFACE
 223 GtkWidget *xface_get_from_header(const gchar *o_xface, GdkColor *background,
 224                                  GdkWindow *window);
 225 #endif
 226 gboolean get_tag_range(GtkTextIter *iter,
 227                                        GtkTextTag *tag,
 228                                        GtkTextIter *start_iter,
 229                                        GtkTextIter *end_iter);
 230
 231 GtkWidget *face_get_from_header(const gchar *o_face);
 232 GtkWidget *gtkut_get_link_btn(GtkWidget *window, const gchar *url, const gchar *label);
 233
 234 GtkWidget *gtkut_sc_combobox_create(GtkWidget *eventbox, gboolean focus_on_click);
 235 void gtkutils_scroll_one_line   (GtkWidget *widget,
 236                                  GtkAdjustment *vadj,
 237                                  gboolean up);
 238 gboolean gtkutils_scroll_page   (GtkWidget *widget,
 239                                  GtkAdjustment *vadj,
 240                                  gboolean up);
 241
 242 gboolean gtkut_tree_model_text_iter_prev(GtkTreeModel *model,
 243                                  GtkTreeIter *iter,
 244                                  const gchar* text);
 245 gboolean gtkut_tree_model_get_iter_last(GtkTreeModel *model,
 246                                  GtkTreeIter *iter);
 247
 248 gboolean gtkut_tree_iter_comp(GtkTreeModel *model,
 249                                      GtkTreeIter *iter1,
 250                                      GtkTreeIter *iter2);
 251
 252 gint gtkut_list_view_get_selected_row(GtkWidget *list_view);
 253 gboolean gtkut_list_view_select_row(GtkWidget *list, gint row);
 254
 255 #endif /* __GTKUTILS_H__ */