2011-01-12 Martin Robinson <mrobinson@igalia.com>
[WebKit-https.git] / Source / WebCore / platform / gtk / gtkdrawing.h
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Mozilla Public License Version
6  * 1.1 (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the
13  * License.
14  *
15  * The Original Code is mozilla.org code.
16  *
17  * The Initial Developer of the Original Code is
18  * Netscape Communications Corporation.
19  * Portions created by the Initial Developer are Copyright (C) 2002
20  * the Initial Developer. All Rights Reserved.
21  *
22  * Contributor(s):
23  *  Brian Ryner <bryner@brianryner.com>  (Original Author)
24  *
25  * Alternatively, the contents of this file may be used under the terms of
26  * either the GNU General Public License Version 2 or later (the "GPL"), or
27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28  * in which case the provisions of the GPL or the LGPL are applicable instead
29  * of those above. If you wish to allow use of your version of this file only
30  * under the terms of either the GPL or the LGPL, and not to allow others to
31  * use your version of this file under the terms of the MPL, indicate your
32  * decision by deleting the provisions above and replace them with the notice
33  * and other provisions required by the GPL or the LGPL. If you do not delete
34  * the provisions above, a recipient may use your version of this file under
35  * the terms of any one of the MPL, the GPL or the LGPL.
36  *
37  * ***** END LICENSE BLOCK ***** */
38
39 /**
40  * gtkdrawing.h: GTK widget rendering utilities
41  *
42  * gtkdrawing provides an API for rendering GTK widgets in the
43  * current theme to a pixmap or window, without requiring an actual
44  * widget instantiation, similar to the Macintosh Appearance Manager
45  * or Windows XP's DrawThemeBackground() API.
46  */
47
48 #ifndef _GTK_DRAWING_H_
49 #define _GTK_DRAWING_H_
50
51 #undef GTK_DISABLE_DEPRECATED
52
53 #include <gtk/gtk.h>
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif /* __cplusplus */
58
59 /*** type definitions ***/
60 typedef struct {
61   guint8 active;
62   guint8 focused;
63   guint8 inHover;
64   guint8 disabled;
65   guint8 isDefault;
66   guint8 canDefault;
67   /* The depressed state is for buttons which remain active for a longer period:
68    * activated toggle buttons or buttons showing a popup menu. */
69   guint8 depressed;
70   gint32 curpos; /* curpos and maxpos are used for scrollbars */
71   gint32 maxpos;
72 } GtkWidgetState;
73
74 typedef struct {
75   gint slider_width;
76   gint trough_border;
77   gint stepper_size;
78   gint stepper_spacing;
79   gint min_slider_size;
80   gboolean trough_under_steppers;
81   gboolean has_secondary_forward_stepper;
82   gboolean has_secondary_backward_stepper;
83 } MozGtkScrollbarMetrics;
84
85 typedef struct _GtkThemeParts {
86     GdkColormap* colormap;
87     GtkWidget* protoWindow;
88     GtkWidget* protoLayout;
89     GtkWidget* buttonWidget;
90     GtkWidget* toggleButtonWidget;
91     GtkWidget* buttonArrowWidget;
92     GtkWidget* horizScrollbarWidget;
93     GtkWidget* vertScrollbarWidget;
94     GtkWidget* comboBoxWidget;
95     GtkWidget* comboBoxButtonWidget;
96     GtkWidget* comboBoxArrowWidget;
97     GtkWidget* comboBoxSeparatorWidget;
98     GtkWidget* comboBoxEntryWidget;
99     GtkWidget* comboBoxEntryTextareaWidget;
100     GtkWidget* comboBoxEntryButtonWidget;
101     GtkWidget* comboBoxEntryArrowWidget;
102     GtkWidget* progresWidget;
103     GtkWidget* scrolledWindowWidget;
104 } GtkThemeParts;
105
106 typedef enum {
107   MOZ_GTK_STEPPER_DOWN        = 1 << 0,
108   MOZ_GTK_STEPPER_BOTTOM      = 1 << 1,
109   MOZ_GTK_STEPPER_VERTICAL    = 1 << 2
110 } GtkScrollbarButtonFlags;
111
112 /* function type for moz_gtk_enable_style_props */
113 typedef gint (*style_prop_t)(GtkStyle*, const gchar*, gint);
114
115 /*** result/error codes ***/
116 #define MOZ_GTK_SUCCESS 0
117 #define MOZ_GTK_UNKNOWN_WIDGET -1
118 #define MOZ_GTK_UNSAFE_THEME -2
119
120 /*** widget type constants ***/
121 typedef enum {
122   /* Paints a GtkButton. flags is a GtkReliefStyle. */
123   MOZ_GTK_BUTTON,
124   /**
125    * Paints the button of a GtkScrollbar. flags is a GtkArrowType giving
126    * the arrow direction.
127    */
128   MOZ_GTK_SCROLLBAR_BUTTON,
129   /* Paints the trough (track) of a GtkScrollbar. */
130   MOZ_GTK_SCROLLBAR_TRACK_HORIZONTAL,
131   MOZ_GTK_SCROLLBAR_TRACK_VERTICAL,
132   /* Paints the slider (thumb) of a GtkScrollbar. */
133   MOZ_GTK_SCROLLBAR_THUMB_HORIZONTAL,
134   MOZ_GTK_SCROLLBAR_THUMB_VERTICAL,
135   /* Paints the background of a scrolled window */
136   MOZ_GTK_SCROLLED_WINDOW,
137   /* Paints a GtkOptionMenu. */
138   MOZ_GTK_DROPDOWN,
139   /* Paints a GtkProgressBar. */
140   MOZ_GTK_PROGRESSBAR,
141   /* Paints a progress chunk of a GtkProgressBar. */
142   MOZ_GTK_PROGRESS_CHUNK
143 } GtkThemeWidgetType;
144
145 /*** General library functions ***/
146 /**
147  * Initializes the drawing library.  You must call this function
148  * prior to using any other functionality.
149  * returns: MOZ_GTK_SUCCESS if there were no errors
150  *          MOZ_GTK_UNSAFE_THEME if the current theme engine is known
151  *                               to crash with gtkdrawing.
152  */
153 gint moz_gtk_init();
154
155 /**
156  * Instruct the drawing library to do all rendering based on
157  * the given collection of theme parts. If any members of the
158  * GtkThemeParts struct are NULL, they will be created lazily.
159  */
160 void
161 moz_gtk_use_theme_parts(GtkThemeParts* parts);
162
163 /**
164  * Enable GTK+ 1.2.9+ theme enhancements. You must provide a pointer
165  * to the GTK+ 1.2.9+ function "gtk_style_get_prop_experimental".
166  * styleGetProp:  pointer to gtk_style_get_prop_experimental
167  * 
168  * returns: MOZ_GTK_SUCCESS if there was no error, an error code otherwise
169  */
170 gint moz_gtk_enable_style_props(style_prop_t styleGetProp);
171
172 /**
173  * Perform cleanup of the drawing library. You should call this function
174  * when your program exits, or you no longer need the library.
175  *
176  * returns: MOZ_GTK_SUCCESS if there was no error, an error code otherwise
177  */
178 gint moz_gtk_shutdown();
179
180 /**
181  * Destroy the widgets in the given GtkThemeParts, which should
182  * be destroyed before the GtkThemeParts can be freed.
183  */
184 void moz_gtk_destroy_theme_parts_widgets(GtkThemeParts* parts);
185
186 /*** Widget drawing ***/
187 /**
188  * Paint a widget in the current theme.
189  * widget:    a constant giving the widget to paint
190  * rect:      the bounding rectangle for the widget
191  * cliprect:  a clipprect rectangle for this painting operation
192  * state:     the state of the widget.  ignored for some widgets.
193  * flags:     widget-dependant flags; see the GtkThemeWidgetType definition.
194  * direction: the text direction, to draw the widget correctly LTR and RTL.
195  */
196 gint
197 moz_gtk_widget_paint(GtkThemeWidgetType widget, GdkDrawable* drawable,
198                      GdkRectangle* rect, GdkRectangle* cliprect,
199                      GtkWidgetState* state, gint flags,
200                      GtkTextDirection direction);
201
202 /*** Widget metrics ***/
203 /**
204  * Get the border size of a widget
205  * left/right:  [OUT] the widget's left/right border
206  * top/bottom:  [OUT] the widget's top/bottom border
207  * direction:   the text direction for the widget
208  * inhtml:      boolean indicating whether this widget will be drawn as a HTML form control,
209  *              in order to workaround a size issue (MOZ_GTK_BUTTON only, ignored otherwise)
210  *
211  * returns:    MOZ_GTK_SUCCESS if there was no error, an error code otherwise
212  */
213 gint moz_gtk_get_widget_border(GtkThemeWidgetType widget, gint* left, gint* top, 
214                                gint* right, gint* bottom, GtkTextDirection direction,
215                                gboolean inhtml);
216
217 /** Get the focus metrics for a treeheadercell, button, checkbox, or radio button.
218  * widget:             [IN]  the widget to get the focus metrics for    
219  * interior_focus:     [OUT] whether the focus is drawn around the
220  *                           label (TRUE) or around the whole container (FALSE)
221  * focus_width:        [OUT] the width of the focus line
222  * focus_pad:          [OUT] the padding between the focus line and children
223  *
224  * returns:    MOZ_GTK_SUCCESS if there was no error, an error code otherwise
225  */
226 gint
227 moz_gtk_widget_get_focus(GtkWidget* widget, gboolean* interior_focus,
228                          gint* focus_width, gint* focus_pad);
229
230 /**
231  * Get the desired metrics for a GtkScrollbar
232  * metrics:          [IN]  struct which will contain the metrics
233  *
234  * returns:    MOZ_GTK_SUCCESS if there was no error, an error code otherwise
235  */
236 gint
237 moz_gtk_get_scrollbar_metrics(MozGtkScrollbarMetrics* metrics);
238
239 /**
240  * Retrieve an actual GTK scrollbar widget for style analysis. It will not
241  * be modified.
242  */
243 GtkWidget* moz_gtk_get_scrollbar_widget(void);
244
245 /**
246  * Retrieve an actual GTK progress bar widget for style analysis. It will not
247  * be modified.
248  */
249 GtkWidget* moz_gtk_get_progress_widget(void);
250
251 #ifdef __cplusplus
252 }
253 #endif /* __cplusplus */
254
255 #endif