src/gtk/gtkutils.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 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 #include "claws-features.h"
  26 #endif
  27
  28 #include <glib.h>
  29 #include <gdk/gdk.h>
  30 #include <gtk/gtk.h>
  31 #include <stdlib.h>
  32 #if HAVE_WCHAR_H
  33 #  include <wchar.h>
  34 #endif
  35
  36 #ifdef MAEMO
  37 #ifdef CHINOOK
  38 #include <hildon/hildon-program.h>
  39 #else
  40 #include <hildon-widgets/hildon-program.h>
  41 #include <hildon-widgets/hildon-window.h>
  42 #endif
  43 #include "main.h"
  44 #endif
  45
  46 #if !GTK_CHECK_VERSION(3, 0, 0)
  47 #include "gtkcmctree.h"
  48 #endif
  49
  50 #ifndef GDK_KEY_Escape
  51 #include "gdkkeysyms-new.h"
  52 #endif
  53
  54 #define GTK_EVENTS_FLUSH() \
  55 { \
  56         while (gtk_events_pending()) \
  57                 gtk_main_iteration(); \
  58 }
  59
  60 #define GTK_WIDGET_PTR(wid)     (*(GtkWidget **)wid)
  61
  62 #define GTKUT_CTREE_NODE_SET_ROW_DATA(node, d) \
  63 { \
  64         GTK_CMCTREE_ROW(node)->row.data = d; \
  65 }
  66
  67 #define GTKUT_CTREE_NODE_GET_ROW_DATA(node) \
  68         (GTK_CMCTREE_ROW(node)->row.data)
  69
  70 #define GTKUT_CTREE_REFRESH(clist) \
  71         GTK_CMCLIST_GET_CLASS(clist)->refresh(clist)
  72
  73 gboolean gtkut_get_font_size            (GtkWidget      *widget,
  74                                          gint           *width,
  75                                          gint           *height);
  76
  77 void gtkut_convert_int_to_gdk_color     (gint            rgbvalue,
  78                                          GdkColor       *color);
  79 gint gtkut_convert_gdk_color_to_int     (GdkColor       *color);
  80
  81 void gtkut_stock_button_add_help(GtkWidget *bbox, GtkWidget **help_btn);
  82
  83 void gtkut_stock_button_set_create_with_help(GtkWidget **bbox,
  84                 GtkWidget **help_button,
  85                 GtkWidget **button1, const gchar *label1,
  86                 GtkWidget **button2, const gchar *label2,
  87                 GtkWidget **button3, const gchar *label3);
  88
  89 void gtkut_stock_button_set_create      (GtkWidget      **bbox,
  90                                          GtkWidget      **button1,
  91                                          const gchar     *label1,
  92                                          GtkWidget      **button2,
  93                                          const gchar     *label2,
  94                                          GtkWidget      **button3,
  95                                          const gchar     *label3);
  96
  97 void gtkut_stock_with_text_button_set_create(GtkWidget **bbox,
  98                                    GtkWidget **button1, const gchar *label1, const gchar *text1,
  99                                    GtkWidget **button2, const gchar *label2, const gchar *text2,
 100                                    GtkWidget **button3, const gchar *label3, const gchar *text3);
 101
 102 #if !GTK_CHECK_VERSION(3, 0, 0)
 103 void gtkut_ctree_node_move_if_on_the_edge
 104                                         (GtkCMCTree     *ctree,
 105                                          GtkCMCTreeNode *node,
 106                                          gint            _row);
 107 gint gtkut_ctree_get_nth_from_node      (GtkCMCTree     *ctree,
 108                                          GtkCMCTreeNode *node);
 109 GtkCMCTreeNode *gtkut_ctree_node_next   (GtkCMCTree     *ctree,
 110                                          GtkCMCTreeNode *node);
 111 GtkCMCTreeNode *gtkut_ctree_node_prev   (GtkCMCTree     *ctree,
 112                                          GtkCMCTreeNode *node);
 113 gboolean gtkut_ctree_node_is_selected   (GtkCMCTree     *ctree,
 114                                          GtkCMCTreeNode *node);
 115 GtkCMCTreeNode *gtkut_ctree_find_collapsed_parent
 116                                         (GtkCMCTree     *ctree,
 117                                          GtkCMCTreeNode *node);
 118 void gtkut_ctree_expand_parent_all      (GtkCMCTree     *ctree,
 119                                          GtkCMCTreeNode *node);
 120 gboolean gtkut_ctree_node_is_parent     (GtkCMCTreeNode         *parent,
 121                                          GtkCMCTreeNode         *node);
 122 void gtkut_ctree_set_focus_row          (GtkCMCTree     *ctree,
 123                                          GtkCMCTreeNode *node);
 124 #endif
 125
 126 void gtkut_clist_set_focus_row          (GtkCMCList     *clist,
 127                                          gint            row);
 128
 129 void gtkut_container_remove             (GtkContainer   *container,
 130                                          GtkWidget      *widget);
 131
 132 gchar *gtkut_text_view_get_selection    (GtkTextView    *textview);
 133 void gtkut_text_view_set_position               (GtkTextView *text, gint pos);
 134 gboolean gtkut_text_view_search_string  (GtkTextView *text, const gchar *str,
 135                                         gboolean case_sens);
 136 gboolean gtkut_text_view_search_string_backward (GtkTextView *text, const gchar *str,
 137                                         gboolean case_sens);
 138
 139 GtkWidget *label_window_create(const gchar *str);
 140 void label_window_destroy(GtkWidget *widget);
 141
 142 void gtkut_window_popup                 (GtkWidget      *window);
 143 GtkWidget *gtkut_window_new             (GtkWindowType   type,
 144                                          const gchar    *class);
 145
 146
 147 void gtkut_widget_get_uposition         (GtkWidget      *widget,
 148                                          gint           *px,
 149                                          gint           *py);
 150 void gtkut_widget_draw_now              (GtkWidget      *widget);
 151 void gtkut_widget_init                  (void);
 152
 153 void gtkut_widget_set_app_icon          (GtkWidget      *widget);
 154 void gtkut_widget_set_composer_icon     (GtkWidget      *widget);
 155
 156 void gtkut_widget_set_mapped            (GtkWidget *widget, gboolean mapped);
 157 void gtkut_widget_set_realized          (GtkWidget *widget, gboolean realized);
 158 void gtkut_widget_set_can_default       (GtkWidget *widget, gboolean can_default);
 159 void gtkut_widget_set_receives_default  (GtkWidget *widget, gboolean receives_default);
 160 void gtkut_widget_set_can_focus         (GtkWidget *widget, gboolean can_focus);
 161 void gtkut_widget_set_has_window        (GtkWidget *widget, gboolean has_window);
 162
 163
 164 GtkWidget *gtkut_account_menu_new       (GList                  *ac_list,
 165                                          GCallback               callback,
 166                                          gpointer                data);
 167
 168 void gtkut_set_widget_bgcolor_rgb       (GtkWidget      *widget,
 169                                          guint           rgbvalue);
 170
 171 void gtkut_widget_set_small_font_size(GtkWidget *widget);
 172 GtkWidget *gtkut_get_focused_child      (GtkContainer   *parent);
 173
 174 GtkWidget *gtkut_get_browse_file_btn(const gchar *label);
 175 GtkWidget *gtkut_get_browse_directory_btn(const gchar *label);
 176 GtkWidget *gtkut_get_replace_btn(const gchar *label);
 177 GtkWidget *gtkut_get_options_frame(GtkWidget *box, GtkWidget **frame, const gchar *frame_label);
 178 #if HAVE_LIBCOMPFACE
 179 GtkWidget *xface_get_from_header(const gchar *o_xface, GdkColor *background,
 180                                  GdkWindow *window);
 181 #endif
 182 gboolean get_tag_range(GtkTextIter *iter,
 183                                        GtkTextTag *tag,
 184                                        GtkTextIter *start_iter,
 185                                        GtkTextIter *end_iter);
 186
 187 GtkWidget *face_get_from_header(const gchar *o_face);
 188 GtkWidget *gtkut_get_link_btn(GtkWidget *window, const gchar *url, const gchar *label);
 189
 190 GtkWidget *gtkut_sc_combobox_create(GtkWidget *eventbox, gboolean focus_on_click);
 191 void gtkutils_scroll_one_line   (GtkWidget *widget,
 192                                  GtkAdjustment *vadj,
 193                                  gboolean up);
 194 gboolean gtkutils_scroll_page   (GtkWidget *widget,
 195                                  GtkAdjustment *vadj,
 196                                  gboolean up);
 197
 198 gboolean gtkut_tree_model_text_iter_prev(GtkTreeModel *model,
 199                                  GtkTreeIter *iter,
 200                                  const gchar* text);
 201 gboolean gtkut_tree_model_get_iter_last(GtkTreeModel *model,
 202                                  GtkTreeIter *iter);
 203
 204 gint gtkut_list_view_get_selected_row(GtkWidget *list_view);
 205 gboolean gtkut_list_view_select_row(GtkWidget *list, gint row);
 206
 207 GtkUIManager *gtkut_create_ui_manager(void);
 208 GtkUIManager *gtkut_ui_manager(void);
 209
 210 GdkPixbuf *claws_load_pixbuf_fitting(GdkPixbuf *pixbuf, int box_width,
 211                                      int box_height);
 212
 213 typedef void (*ClawsIOFunc)(gpointer data, gint source, GIOCondition condition);
 214 gint
 215 claws_input_add    (gint              source,
 216                     GIOCondition      condition,
 217                     ClawsIOFunc       function,
 218                     gpointer          data,
 219                     gboolean          is_sock);
 220
 221 #define CLAWS_SET_TIP(widget,tip) {                                     \
 222         if (tip != NULL)                                                \
 223                 gtk_widget_set_tooltip_text(GTK_WIDGET(widget), tip);   \
 224         else                                                            \
 225                 gtk_widget_set_has_tooltip(GTK_WIDGET(widget), FALSE);  \
 226 }
 227
 228 #if !GTK_CHECK_VERSION(2,22,0)
 229 #define gdk_drag_context_get_selected_action(x) ((x)->action)
 230 #define gdk_drag_context_get_actions(x) ((x)->actions)
 231 #define gtk_text_view_get_vadjustment(x) ((x)->vadjustment)
 232 #define gdk_drag_context_get_suggested_action(x) ((x)->suggested_action)
 233 #define gtk_button_get_event_window(x) ((x)->event_window)
 234 #endif
 235 #if !GTK_CHECK_VERSION(2,20,0)
 236 #define gtk_widget_get_requisition(x,r) (*(r) = (x)->requisition)
 237 #define gtk_statusbar_get_message_area(x) ((x)->label)
 238 #define gtk_widget_get_realized(x) (GTK_WIDGET_REALIZED(x))
 239 #define gtk_widget_get_mapped(x) (GTK_WIDGET_MAPPED(x))
 240 #endif
 241 #if !GTK_CHECK_VERSION(2,18,0)
 242 #define gtk_widget_get_allocation(x,a) (*(a) = (x)->allocation)
 243 #define gtk_widget_set_allocation(x,a) ((x)->allocation = *(a))
 244 #define gtk_widget_has_focus(x) (GTK_WIDGET_HAS_FOCUS(x))
 245 #define gtk_widget_get_can_focus(x) (GTK_WIDGET_CAN_FOCUS(x))
 246 #define gtk_widget_has_grab(x) (GTK_WIDGET_HAS_GRAB(x))
 247 #define gtk_widget_get_visible(x) (GTK_WIDGET_VISIBLE(x))
 248 #define gtk_widget_get_realized(x) (GTK_WIDGET_REALIZED(x))
 249 #define gtk_widget_is_sensitive(x) (GTK_WIDGET_IS_SENSITIVE(x))
 250 #define gtk_widget_get_sensitive(x) (GTK_WIDGET_SENSITIVE(x))
 251 #define gtk_widget_is_drawable(x) (GTK_WIDGET_DRAWABLE(x))
 252 #define gtk_widget_get_state(x) (GTK_WIDGET_STATE(x))
 253 #define gtk_widget_get_mapped(x) (GTK_WIDGET_MAPPED(x))
 254 #define gtk_widget_get_has_window(x) (!(GTK_WIDGET_NO_WINDOW(x)))
 255 #define gtk_widget_get_app_paintable(x) (GTK_WIDGET_APP_PAINTABLE(x))
 256 #define gtk_widget_set_window(x,w) {                    \
 257         if ((x)->window != w) {                         \
 258                 (x)->window = w;                        \
 259                 g_object_notify (G_OBJECT(x), "window");\
 260         }                                               \
 261 }
 262 #endif
 263 #endif /* __GTKUTILS_H__ */