]> Pileus Git - ~andy/gtk/blob - gtk/gtkstylecontext.h
80d5abca21b556895dfbffd7dafd19ada56ffd54
[~andy/gtk] / gtk / gtkstylecontext.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
22 #endif
23
24 #ifndef __GTK_STYLE_CONTEXT_H__
25 #define __GTK_STYLE_CONTEXT_H__
26
27 #include <glib-object.h>
28 #include <gtk/gtkstyleprovider.h>
29 #include <gtk/gtkwidgetpath.h>
30 #include <gtk/gtkborder.h>
31
32 G_BEGIN_DECLS
33
34 #define GTK_TYPE_STYLE_CONTEXT         (gtk_style_context_get_type ())
35 #define GTK_STYLE_CONTEXT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContext))
36 #define GTK_STYLE_CONTEXT_CLASS(c)     (G_TYPE_CHECK_CLASS_CAST    ((c), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))
37 #define GTK_IS_STYLE_CONTEXT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_STYLE_CONTEXT))
38 #define GTK_IS_STYLE_CONTEXT_CLASS(c)  (G_TYPE_CHECK_CLASS_TYPE    ((c), GTK_TYPE_STYLE_CONTEXT))
39 #define GTK_STYLE_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS  ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))
40
41 typedef struct _GtkStyleContext GtkStyleContext;
42 typedef struct _GtkStyleContextClass GtkStyleContextClass;
43
44 struct _GtkStyleContext
45 {
46   GObject parent_object;
47   gpointer priv;
48 };
49
50 struct _GtkStyleContextClass
51 {
52   GObjectClass parent_class;
53
54   void (* changed) (GtkStyleContext *context);
55 };
56
57 /* Default set of properties that GtkStyleContext may contain */
58
59 /**
60  * GTK_STYLE_PROPERTY_BACKGROUND_COLOR:
61  *
62  * A property holding the background color of rendered elements as a #GdkRGBA.
63  */
64 #define GTK_STYLE_PROPERTY_BACKGROUND_COLOR "background-color"
65
66 /**
67  * GTK_STYLE_PROPERTY_COLOR:
68  *
69  * A property holding the foreground color of rendered elements as a #GdkRGBA.
70  */
71 #define GTK_STYLE_PROPERTY_COLOR "color"
72
73 /**
74  * GTK_STYLE_PROPERTY_FONT:
75  *
76  * A property holding the font properties used when rendering text
77  * as a #PangoFontDescription.
78  */
79 #define GTK_STYLE_PROPERTY_FONT "font"
80
81 /**
82  * GTK_STYLE_PROPERTY_MARGIN:
83  *
84  * A property holding the rendered element's margin as a #GtkBorder. The
85  * margin is defined as the spacing between the border of the element
86  * and its surrounding elements.
87  */
88 #define GTK_STYLE_PROPERTY_MARGIN "margin"
89
90 /**
91  * GTK_STYLE_PROPERTY_PADDING:
92  *
93  * A property holding the rendered element's padding as a #GtkBorder. The
94  * padding is defined as the spacing between the inner part of the element border
95  * and its child.
96  */
97 #define GTK_STYLE_PROPERTY_PADDING "padding"
98
99 /**
100  * GTK_STYLE_PROPERTY_BORDER_WIDTH:
101  *
102  * A property holding the rendered element's border width in pixels as a #gint.
103  */
104 #define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"
105
106 /**
107  * GTK_STYLE_PROPERTY_BORDER_RADIUS:
108  *
109  * A property holding the rendered element's border radius in pixels as a #gint.
110  */
111 #define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"
112
113 /**
114  * GTK_STYLE_PROPERTY_BORDER_STYLE:
115  *
116  * A property holding the element's border style as a #GtkBorderStyle.
117  */
118 #define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"
119
120 /**
121  * GTK_STYLE_PROPERTY_BORDER_COLOR:
122  *
123  * A property holding the element's border color as a #GdkRGBA.
124  */
125 #define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"
126
127 /**
128  * GTK_STYLE_PROPERTY_BACKGROUND_IMAGE:
129  *
130  * A property holding the element's background as a #cairo_pattern_t.
131  */
132 #define GTK_STYLE_PROPERTY_BACKGROUND_IMAGE "background-image"
133
134
135 /* Predefined set of CSS classes */
136
137 /**
138  * GTK_STYLE_CLASS_CELL:
139  *
140  * A CSS class to match content rendered in cell views.
141  */
142 #define GTK_STYLE_CLASS_CELL "cell"
143
144 /**
145  * GTK_STYLE_CLASS_ENTRY:
146  *
147  * A CSS class to match text entries.
148  */
149 #define GTK_STYLE_CLASS_ENTRY "entry"
150
151 /**
152  * GTK_STYLE_CLASS_BUTTON:
153  *
154  * A CSS class to match buttons.
155  */
156 #define GTK_STYLE_CLASS_BUTTON "button"
157
158 /**
159  * GTK_STYLE_CLASS_CALENDAR:
160  *
161  * A CSS class to match calendars.
162  */
163 #define GTK_STYLE_CLASS_CALENDAR "calendar"
164
165 /**
166  * GTK_STYLE_CLASS_SLIDER:
167  *
168  * A CSS class to match sliders.
169  */
170 #define GTK_STYLE_CLASS_SLIDER "slider"
171
172 /**
173  * GTK_STYLE_CLASS_BACKGROUND:
174  *
175  * A CSS class to match the window background.
176  */
177 #define GTK_STYLE_CLASS_BACKGROUND "background"
178
179 /**
180  * GTK_STYLE_CLASS_RUBBERBAND:
181  *
182  * A CSS class to match the rubberband selection rectangle.
183  */
184 #define GTK_STYLE_CLASS_RUBBERBAND "rubberband"
185
186 /**
187  * GTK_STYLE_CLASS_TOOLTIP:
188  *
189  * A CSS class to match tooltip windows.
190  */
191 #define GTK_STYLE_CLASS_TOOLTIP "tooltip"
192
193 /**
194  * GTK_STYLE_CLASS_MENU:
195  *
196  * A CSS class to match popup menus.
197  */
198 #define GTK_STYLE_CLASS_MENU "menu"
199
200 /**
201  * GTK_STYLE_CLASS_MENUBAR:
202  *
203  * A CSS class to menubars.
204  */
205 #define GTK_STYLE_CLASS_MENUBAR "menubar"
206
207 /**
208  * GTK_STYLE_CLASS_MENUITEM:
209  *
210  * A CSS class to match menu items.
211  */
212 #define GTK_STYLE_CLASS_MENUITEM "menuitem"
213
214 /**
215  * GTK_STYLE_CLASS_TOOLBAR:
216  *
217  * A CSS class to match toolbars.
218  */
219 #define GTK_STYLE_CLASS_TOOLBAR "toolbar"
220
221 /**
222  * GTK_STYLE_CLASS_RADIO:
223  *
224  * A CSS class to match radio buttons.
225  */
226 #define GTK_STYLE_CLASS_RADIO "radio"
227
228 /**
229  * GTK_STYLE_CLASS_CHECK:
230  *
231  * A CSS class to match check boxes.
232  */
233 #define GTK_STYLE_CLASS_CHECK "check"
234
235 /**
236  * GTK_STYLE_CLASS_DEFAULT:
237  *
238  * A CSS class to match the default widget.
239  */
240 #define GTK_STYLE_CLASS_DEFAULT "default"
241
242 /**
243  * GTK_STYLE_CLASS_TROUGH:
244  *
245  * A CSS class to match troughs, as in scrollbars and progressbars.
246  */
247 #define GTK_STYLE_CLASS_TROUGH "trough"
248
249 /**
250  * GTK_STYLE_CLASS_SCROLLBAR:
251  *
252  * A CSS class to match scrollbars.
253  */
254 #define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"
255
256 /**
257  * GTK_STYLE_CLASS_SCALE:
258  *
259  * A CSS class to match scale widgets.
260  */
261 #define GTK_STYLE_CLASS_SCALE "scale"
262
263 /**
264  * GTK_STYLE_CLASS_HEADER:
265  *
266  * A CSS class to match a header element.
267  */
268 #define GTK_STYLE_CLASS_HEADER "header"
269
270 /**
271  * GTK_STYLE_CLASS_ACCELERATOR:
272  *
273  * A CSS class to match an accelerator.
274  */
275 #define GTK_STYLE_CLASS_ACCELERATOR "accelerator"
276
277 /**
278  * GTK_STYLE_CLASS_GRIP:
279  *
280  * A widget class defining a resize grip
281  */
282 #define GTK_STYLE_CLASS_GRIP "grip"
283
284 /**
285  * GTK_STYLE_CLASS_DOCK:
286  *
287  * A widget class defining a dock area
288  */
289 #define GTK_STYLE_CLASS_DOCK "dock"
290
291 /**
292  * GTK_STYLE_CLASS_PROGRESSBAR:
293  *
294  * A widget class defining a resize grip
295  */
296 #define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
297
298 /**
299  * GTK_STYLE_CLASS_SPINNER:
300  *
301  * A widget class defining a spinner
302  */
303 #define GTK_STYLE_CLASS_SPINNER "spinner"
304
305 /**
306  * GTK_STYLE_CLASS_MARK:
307  *
308  * A widget class defining marks in a widget, such as in scales
309  */
310 #define GTK_STYLE_CLASS_MARK "mark"
311
312 /**
313  * GTK_STYLE_CLASS_EXPANDER:
314  *
315  * A widget class defining an expander, such as those in treeviews
316  */
317 #define GTK_STYLE_CLASS_EXPANDER "expander"
318
319 /**
320  * GTK_STYLE_CLASS_SPINBUTTON:
321  *
322  * A widget class defining an spinbutton
323  */
324 #define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"
325
326 /**
327  * GTK_STYLE_CLASS_NOTEBOOK:
328  *
329  * A widget class defining a notebook
330  */
331 #define GTK_STYLE_CLASS_NOTEBOOK "notebook"
332
333 /**
334  * GTK_STYLE_CLASS_VIEW:
335  *
336  * A widget class defining a view, such as iconviews or treeviews
337  */
338 #define GTK_STYLE_CLASS_VIEW "view"
339
340 /**
341  * GTK_STYLE_CLASS_INFO:
342  *
343  * A widget class for an area displaying an informational message,
344  * such as those in infobars
345  */
346 #define GTK_STYLE_CLASS_INFO "info"
347
348 /**
349  * GTK_STYLE_CLASS_WARNING:
350  *
351  * A widget class for an area displaying a warning message,
352  * such as those in infobars
353  */
354 #define GTK_STYLE_CLASS_WARNING "warning"
355
356 /**
357  * GTK_STYLE_CLASS_QUESTION:
358  *
359  * A widget class for an area displaying a question to the user,
360  * such as those in infobars
361  */
362 #define GTK_STYLE_CLASS_QUESTION "question"
363
364 /**
365  * GTK_STYLE_CLASS_ERROR:
366  *
367  * A widget class for an area displaying an error message,
368  * such as those in infobars
369  */
370 #define GTK_STYLE_CLASS_ERROR "error"
371
372
373 /* Predefined set of widget regions */
374
375 /**
376  * GTK_STYLE_REGION_ROW:
377  *
378  * A widget region name to define a treeview row.
379  */
380 #define GTK_STYLE_REGION_ROW "row"
381
382 /**
383  * GTK_STYLE_REGION_COLUMN:
384  *
385  * A widget region name to define a treeview column.
386  */
387 #define GTK_STYLE_REGION_COLUMN "column"
388
389 /**
390  * GTK_STYLE_REGION_COLUMN_HEADER:
391  *
392  * A widget region name to define a treeview column header.
393  */
394 #define GTK_STYLE_REGION_COLUMN_HEADER "column-header"
395
396 /**
397  * GTK_STYLE_REGION_TAB:
398  *
399  * A widget region name to define a notebook tab.
400  */
401 #define GTK_STYLE_REGION_TAB "tab"
402
403
404 GType gtk_style_context_get_type (void) G_GNUC_CONST;
405
406 GtkStyleContext * gtk_style_context_new (void);
407
408 void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
409                                                    GtkStyleProvider *provider,
410                                                    guint             priority);
411 void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
412                                                    GtkStyleProvider *provider);
413
414 void gtk_style_context_add_provider    (GtkStyleContext  *context,
415                                         GtkStyleProvider *provider,
416                                         guint             priority);
417
418 void gtk_style_context_remove_provider (GtkStyleContext  *context,
419                                         GtkStyleProvider *provider);
420
421 void gtk_style_context_save    (GtkStyleContext *context);
422 void gtk_style_context_restore (GtkStyleContext *context);
423
424 void gtk_style_context_get_property (GtkStyleContext *context,
425                                      const gchar     *property,
426                                      GtkStateFlags    state,
427                                      GValue          *value);
428 void gtk_style_context_get_valist   (GtkStyleContext *context,
429                                      GtkStateFlags    state,
430                                      va_list          args);
431 void gtk_style_context_get          (GtkStyleContext *context,
432                                      GtkStateFlags    state,
433                                      ...) G_GNUC_NULL_TERMINATED;
434
435 void          gtk_style_context_set_state    (GtkStyleContext *context,
436                                               GtkStateFlags    flags);
437 GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);
438
439 gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
440                                                   GtkStateType     state,
441                                                   gdouble         *progress);
442
443 void          gtk_style_context_set_path     (GtkStyleContext *context,
444                                               GtkWidgetPath   *path);
445 G_CONST_RETURN GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
446
447 GList *  gtk_style_context_list_classes (GtkStyleContext *context);
448
449 void     gtk_style_context_add_class    (GtkStyleContext *context,
450                                          const gchar     *class_name);
451 void     gtk_style_context_remove_class (GtkStyleContext *context,
452                                          const gchar     *class_name);
453 gboolean gtk_style_context_has_class    (GtkStyleContext *context,
454                                          const gchar     *class_name);
455
456 GList *  gtk_style_context_list_regions (GtkStyleContext *context);
457
458 void     gtk_style_context_add_region    (GtkStyleContext    *context,
459                                           const gchar        *region_name,
460                                           GtkRegionFlags      flags);
461 void     gtk_style_context_remove_region (GtkStyleContext    *context,
462                                           const gchar        *region_name);
463 gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
464                                           const gchar        *region_name,
465                                           GtkRegionFlags     *flags_return);
466
467 void gtk_style_context_get_style_property (GtkStyleContext *context,
468                                            const gchar     *property_name,
469                                            GValue          *value);
470 void gtk_style_context_get_style_valist   (GtkStyleContext *context,
471                                            va_list          args);
472 void gtk_style_context_get_style          (GtkStyleContext *context,
473                                            ...);
474
475 GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
476                                                 const gchar     *stock_id);
477 GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
478                                                 GtkStyleContext *context,
479                                                 GtkIconSize      size);
480
481 void        gtk_style_context_set_screen (GtkStyleContext *context,
482                                           GdkScreen       *screen);
483 GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);
484
485 void             gtk_style_context_set_direction (GtkStyleContext  *context,
486                                                   GtkTextDirection  direction);
487 GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);
488
489 void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
490                                                        GtkJunctionSides  sides);
491 GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);
492
493 gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
494                                          const gchar     *color_name,
495                                          GdkRGBA         *color);
496
497 void  gtk_style_context_notify_state_change (GtkStyleContext *context,
498                                              GdkWindow       *window,
499                                              gpointer         region_id,
500                                              GtkStateType     state,
501                                              gboolean         state_value);
502 void gtk_style_context_push_animatable_region (GtkStyleContext *context,
503                                                gpointer         region_id);
504 void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);
505
506 /* Some helper functions to retrieve most common properties */
507 void gtk_style_context_get_color            (GtkStyleContext *context,
508                                              GtkStateFlags    state,
509                                              GdkRGBA         *color);
510 void gtk_style_context_get_background_color (GtkStyleContext *context,
511                                              GtkStateFlags    state,
512                                              GdkRGBA         *color);
513 void gtk_style_context_get_border_color     (GtkStyleContext *context,
514                                              GtkStateFlags    state,
515                                              GdkRGBA         *color);
516
517 const PangoFontDescription * gtk_style_context_get_font (GtkStyleContext *context,
518                                                     GtkStateFlags    state);
519
520 void gtk_style_context_get_border           (GtkStyleContext *context,
521                                              GtkStateFlags    state,
522                                              GtkBorder       *border);
523 void gtk_style_context_get_padding          (GtkStyleContext *context,
524                                              GtkStateFlags    state,
525                                              GtkBorder       *padding);
526 void gtk_style_context_get_margin           (GtkStyleContext *context,
527                                              GtkStateFlags    state,
528                                              GtkBorder       *margin);
529
530 /* Semi-private API */
531 const GValue * _gtk_style_context_peek_style_property (GtkStyleContext *context,
532                                                        GType            widget_type,
533                                                        GtkStateFlags    state,
534                                                        GParamSpec      *pspec);
535 void           _gtk_style_context_invalidate_animation_areas (GtkStyleContext *context);
536 void           _gtk_style_context_coalesce_animation_areas   (GtkStyleContext *context,
537                                                               GtkWidget       *widget);
538
539 void gtk_style_context_invalidate (GtkStyleContext *context);
540 void gtk_style_context_reset_widgets (GdkScreen *screen);
541
542 void gtk_style_context_set_background (GtkStyleContext *context,
543                                        GdkWindow       *window);
544
545 /* Paint methods */
546 void gtk_render_check (GtkStyleContext *context,
547                        cairo_t         *cr,
548                        gdouble          x,
549                        gdouble          y,
550                        gdouble          width,
551                        gdouble          height);
552 void gtk_render_option (GtkStyleContext *context,
553                         cairo_t         *cr,
554                         gdouble          x,
555                         gdouble          y,
556                         gdouble          width,
557                         gdouble          height);
558 void gtk_render_arrow  (GtkStyleContext *context,
559                         cairo_t         *cr,
560                         gdouble          angle,
561                         gdouble          x,
562                         gdouble          y,
563                         gdouble          size);
564 void gtk_render_background (GtkStyleContext *context,
565                             cairo_t         *cr,
566                             gdouble          x,
567                             gdouble          y,
568                             gdouble          width,
569                             gdouble          height);
570 void gtk_render_frame  (GtkStyleContext *context,
571                         cairo_t         *cr,
572                         gdouble          x,
573                         gdouble          y,
574                         gdouble          width,
575                         gdouble          height);
576 void gtk_render_expander (GtkStyleContext *context,
577                           cairo_t         *cr,
578                           gdouble          x,
579                           gdouble          y,
580                           gdouble          width,
581                           gdouble          height);
582 void gtk_render_focus    (GtkStyleContext *context,
583                           cairo_t         *cr,
584                           gdouble          x,
585                           gdouble          y,
586                           gdouble          width,
587                           gdouble          height);
588 void gtk_render_layout   (GtkStyleContext *context,
589                           cairo_t         *cr,
590                           gdouble          x,
591                           gdouble          y,
592                           PangoLayout     *layout);
593 void gtk_render_line     (GtkStyleContext *context,
594                           cairo_t         *cr,
595                           gdouble          x0,
596                           gdouble          y0,
597                           gdouble          x1,
598                           gdouble          y1);
599 void gtk_render_slider   (GtkStyleContext *context,
600                           cairo_t         *cr,
601                           gdouble          x,
602                           gdouble          y,
603                           gdouble          width,
604                           gdouble          height,
605                           GtkOrientation   orientation);
606 void gtk_render_frame_gap (GtkStyleContext *context,
607                            cairo_t         *cr,
608                            gdouble          x,
609                            gdouble          y,
610                            gdouble          width,
611                            gdouble          height,
612                            GtkPositionType  gap_side,
613                            gdouble          xy0_gap,
614                            gdouble          xy1_gap);
615 void gtk_render_extension (GtkStyleContext *context,
616                            cairo_t         *cr,
617                            gdouble          x,
618                            gdouble          y,
619                            gdouble          width,
620                            gdouble          height,
621                            GtkPositionType  gap_side);
622 void gtk_render_handle    (GtkStyleContext *context,
623                            cairo_t         *cr,
624                            gdouble          x,
625                            gdouble          y,
626                            gdouble          width,
627                            gdouble          height);
628 void gtk_render_activity  (GtkStyleContext *context,
629                            cairo_t         *cr,
630                            gdouble          x,
631                            gdouble          y,
632                            gdouble          width,
633                            gdouble          height);
634
635 GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext     *context,
636                                     const GtkIconSource *source,
637                                     GtkIconSize          size);
638
639 G_END_DECLS
640
641 #endif /* __GTK_STYLE_CONTEXT_H__ */