1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
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.
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.
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.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_STYLE_CONTEXT_H__
25 #define __GTK_STYLE_CONTEXT_H__
27 #include <glib-object.h>
28 #include <gtk/gtkstyleprovider.h>
29 #include <gtk/gtkwidgetpath.h>
30 #include <gtk/gtkborder.h>
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))
41 typedef struct _GtkStyleContext GtkStyleContext;
42 typedef struct _GtkStyleContextClass GtkStyleContextClass;
44 struct _GtkStyleContext
46 GObject parent_object;
50 struct _GtkStyleContextClass
52 GObjectClass parent_class;
54 void (* changed) (GtkStyleContext *context);
57 /* Default set of properties that GtkStyleContext may contain */
60 * GTK_STYLE_PROPERTY_BACKGROUND_COLOR:
62 * A property holding the background color of rendered elements as a #GdkRGBA.
64 #define GTK_STYLE_PROPERTY_BACKGROUND_COLOR "background-color"
67 * GTK_STYLE_PROPERTY_COLOR:
69 * A property holding the foreground color of rendered elements as a #GdkRGBA.
71 #define GTK_STYLE_PROPERTY_COLOR "color"
74 * GTK_STYLE_PROPERTY_FONT:
76 * A property holding the font properties used when rendering text
77 * as a #PangoFontDescription.
79 #define GTK_STYLE_PROPERTY_FONT "font"
82 * GTK_STYLE_PROPERTY_MARGIN:
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.
88 #define GTK_STYLE_PROPERTY_MARGIN "margin"
91 * GTK_STYLE_PROPERTY_PADDING:
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
97 #define GTK_STYLE_PROPERTY_PADDING "padding"
100 * GTK_STYLE_PROPERTY_BORDER_WIDTH:
102 * A property holding the rendered element's border width in pixels as a #gint.
104 #define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"
107 * GTK_STYLE_PROPERTY_BORDER_RADIUS:
109 * A property holding the rendered element's border radius in pixels as a #gint.
111 #define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"
114 * GTK_STYLE_PROPERTY_BORDER_STYLE:
116 * A property holding the element's border style as a #GtkBorderStyle.
118 #define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"
121 * GTK_STYLE_PROPERTY_BORDER_COLOR:
123 * A property holding the element's border color as a #GdkRGBA.
125 #define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"
128 * GTK_STYLE_PROPERTY_BACKGROUND_IMAGE:
130 * A property holding the element's background as a #cairo_pattern_t.
132 #define GTK_STYLE_PROPERTY_BACKGROUND_IMAGE "background-image"
135 /* Predefined set of CSS classes */
138 * GTK_STYLE_CLASS_CELL:
140 * A CSS class to match content rendered in cell views.
142 #define GTK_STYLE_CLASS_CELL "cell"
145 * GTK_STYLE_CLASS_ENTRY:
147 * A CSS class to match text entries.
149 #define GTK_STYLE_CLASS_ENTRY "entry"
152 * GTK_STYLE_CLASS_BUTTON:
154 * A CSS class to match buttons.
156 #define GTK_STYLE_CLASS_BUTTON "button"
159 * GTK_STYLE_CLASS_CALENDAR:
161 * A CSS class to match calendars.
163 #define GTK_STYLE_CLASS_CALENDAR "calendar"
166 * GTK_STYLE_CLASS_SLIDER:
168 * A CSS class to match sliders.
170 #define GTK_STYLE_CLASS_SLIDER "slider"
173 * GTK_STYLE_CLASS_BACKGROUND:
175 * A CSS class to match the window background.
177 #define GTK_STYLE_CLASS_BACKGROUND "background"
180 * GTK_STYLE_CLASS_RUBBERBAND:
182 * A CSS class to match the rubberband selection rectangle.
184 #define GTK_STYLE_CLASS_RUBBERBAND "rubberband"
187 * GTK_STYLE_CLASS_TOOLTIP:
189 * A CSS class to match tooltip windows.
191 #define GTK_STYLE_CLASS_TOOLTIP "tooltip"
194 * GTK_STYLE_CLASS_MENU:
196 * A CSS class to match popup menus.
198 #define GTK_STYLE_CLASS_MENU "menu"
201 * GTK_STYLE_CLASS_MENUBAR:
203 * A CSS class to menubars.
205 #define GTK_STYLE_CLASS_MENUBAR "menubar"
208 * GTK_STYLE_CLASS_MENUITEM:
210 * A CSS class to match menu items.
212 #define GTK_STYLE_CLASS_MENUITEM "menuitem"
215 * GTK_STYLE_CLASS_TOOLBAR:
217 * A CSS class to match toolbars.
219 #define GTK_STYLE_CLASS_TOOLBAR "toolbar"
222 * GTK_STYLE_CLASS_RADIO:
224 * A CSS class to match radio buttons.
226 #define GTK_STYLE_CLASS_RADIO "radio"
229 * GTK_STYLE_CLASS_CHECK:
231 * A CSS class to match check boxes.
233 #define GTK_STYLE_CLASS_CHECK "check"
236 * GTK_STYLE_CLASS_DEFAULT:
238 * A CSS class to match the default widget.
240 #define GTK_STYLE_CLASS_DEFAULT "default"
243 * GTK_STYLE_CLASS_TROUGH:
245 * A CSS class to match troughs, as in scrollbars and progressbars.
247 #define GTK_STYLE_CLASS_TROUGH "trough"
250 * GTK_STYLE_CLASS_SCROLLBAR:
252 * A CSS class to match scrollbars.
254 #define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"
257 * GTK_STYLE_CLASS_SCALE:
259 * A CSS class to match scale widgets.
261 #define GTK_STYLE_CLASS_SCALE "scale"
264 * GTK_STYLE_CLASS_HEADER:
266 * A CSS class to match a header element.
268 #define GTK_STYLE_CLASS_HEADER "header"
271 * GTK_STYLE_CLASS_ACCELERATOR:
273 * A CSS class to match an accelerator.
275 #define GTK_STYLE_CLASS_ACCELERATOR "accelerator"
278 * GTK_STYLE_CLASS_GRIP:
280 * A widget class defining a resize grip
282 #define GTK_STYLE_CLASS_GRIP "grip"
285 * GTK_STYLE_CLASS_DOCK:
287 * A widget class defining a dock area
289 #define GTK_STYLE_CLASS_DOCK "dock"
292 * GTK_STYLE_CLASS_PROGRESSBAR:
294 * A widget class defining a resize grip
296 #define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
299 * GTK_STYLE_CLASS_SPINNER:
301 * A widget class defining a spinner
303 #define GTK_STYLE_CLASS_SPINNER "spinner"
306 * GTK_STYLE_CLASS_MARK:
308 * A widget class defining marks in a widget, such as in scales
310 #define GTK_STYLE_CLASS_MARK "mark"
313 * GTK_STYLE_CLASS_EXPANDER:
315 * A widget class defining an expander, such as those in treeviews
317 #define GTK_STYLE_CLASS_EXPANDER "expander"
320 * GTK_STYLE_CLASS_SPINBUTTON:
322 * A widget class defining an spinbutton
324 #define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"
327 * GTK_STYLE_CLASS_NOTEBOOK:
329 * A widget class defining a notebook
331 #define GTK_STYLE_CLASS_NOTEBOOK "notebook"
334 * GTK_STYLE_CLASS_VIEW:
336 * A widget class defining a view, such as iconviews or treeviews
338 #define GTK_STYLE_CLASS_VIEW "view"
341 * GTK_STYLE_CLASS_HIGHLIGHT:
343 * A CSS class defining a highlighted area, such as headings in
346 #define GTK_STYLE_CLASS_HIGHLIGHT "highlight"
349 * GTK_STYLE_CLASS_FRAME:
351 * A CSS class defining a frame delimiting content, such as GtkFrame
352 * or the scrolled window frame around the scrollable area.
354 #define GTK_STYLE_CLASS_FRAME "frame"
357 * GTK_STYLE_CLASS_DND:
359 * A CSS class for a drag-and-drop indicator
361 #define GTK_STYLE_CLASS_DND "dnd"
364 * GTK_STYLE_CLASS_PANE_SEPARATOR:
366 * A CSS class for a pane separator, such as those in #GtkPaned.
368 #define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"
371 * GTK_STYLE_CLASS_INFO:
373 * A widget class for an area displaying an informational message,
374 * such as those in infobars
376 #define GTK_STYLE_CLASS_INFO "info"
379 * GTK_STYLE_CLASS_WARNING:
381 * A widget class for an area displaying a warning message,
382 * such as those in infobars
384 #define GTK_STYLE_CLASS_WARNING "warning"
387 * GTK_STYLE_CLASS_QUESTION:
389 * A widget class for an area displaying a question to the user,
390 * such as those in infobars
392 #define GTK_STYLE_CLASS_QUESTION "question"
395 * GTK_STYLE_CLASS_ERROR:
397 * A widget class for an area displaying an error message,
398 * such as those in infobars
400 #define GTK_STYLE_CLASS_ERROR "error"
403 * GTK_STYLE_CLASS_HORIZONTAL:
405 * A widget class for horizontally layered widgets.
407 #define GTK_STYLE_CLASS_HORIZONTAL "horizontal"
410 * GTK_STYLE_CLASS_VERTICAL:
412 * A widget class for vertically layered widgets.
414 #define GTK_STYLE_CLASS_VERTICAL "vertical"
417 /* Predefined set of widget regions */
420 * GTK_STYLE_REGION_ROW:
422 * A widget region name to define a treeview row.
424 #define GTK_STYLE_REGION_ROW "row"
427 * GTK_STYLE_REGION_COLUMN:
429 * A widget region name to define a treeview column.
431 #define GTK_STYLE_REGION_COLUMN "column"
434 * GTK_STYLE_REGION_COLUMN_HEADER:
436 * A widget region name to define a treeview column header.
438 #define GTK_STYLE_REGION_COLUMN_HEADER "column-header"
441 * GTK_STYLE_REGION_TAB:
443 * A widget region name to define a notebook tab.
445 #define GTK_STYLE_REGION_TAB "tab"
448 GType gtk_style_context_get_type (void) G_GNUC_CONST;
450 GtkStyleContext * gtk_style_context_new (void);
452 void gtk_style_context_add_provider_for_screen (GdkScreen *screen,
453 GtkStyleProvider *provider,
455 void gtk_style_context_remove_provider_for_screen (GdkScreen *screen,
456 GtkStyleProvider *provider);
458 void gtk_style_context_add_provider (GtkStyleContext *context,
459 GtkStyleProvider *provider,
462 void gtk_style_context_remove_provider (GtkStyleContext *context,
463 GtkStyleProvider *provider);
465 void gtk_style_context_save (GtkStyleContext *context);
466 void gtk_style_context_restore (GtkStyleContext *context);
468 void gtk_style_context_get_property (GtkStyleContext *context,
469 const gchar *property,
472 void gtk_style_context_get_valist (GtkStyleContext *context,
475 void gtk_style_context_get (GtkStyleContext *context,
477 ...) G_GNUC_NULL_TERMINATED;
479 void gtk_style_context_set_state (GtkStyleContext *context,
480 GtkStateFlags flags);
481 GtkStateFlags gtk_style_context_get_state (GtkStyleContext *context);
483 gboolean gtk_style_context_state_is_running (GtkStyleContext *context,
487 void gtk_style_context_set_path (GtkStyleContext *context,
488 GtkWidgetPath *path);
489 G_CONST_RETURN GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
491 GList * gtk_style_context_list_classes (GtkStyleContext *context);
493 void gtk_style_context_add_class (GtkStyleContext *context,
494 const gchar *class_name);
495 void gtk_style_context_remove_class (GtkStyleContext *context,
496 const gchar *class_name);
497 gboolean gtk_style_context_has_class (GtkStyleContext *context,
498 const gchar *class_name);
500 GList * gtk_style_context_list_regions (GtkStyleContext *context);
502 void gtk_style_context_add_region (GtkStyleContext *context,
503 const gchar *region_name,
504 GtkRegionFlags flags);
505 void gtk_style_context_remove_region (GtkStyleContext *context,
506 const gchar *region_name);
507 gboolean gtk_style_context_has_region (GtkStyleContext *context,
508 const gchar *region_name,
509 GtkRegionFlags *flags_return);
511 void gtk_style_context_get_style_property (GtkStyleContext *context,
512 const gchar *property_name,
514 void gtk_style_context_get_style_valist (GtkStyleContext *context,
516 void gtk_style_context_get_style (GtkStyleContext *context,
519 GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
520 const gchar *stock_id);
521 GdkPixbuf * gtk_icon_set_render_icon_pixbuf (GtkIconSet *icon_set,
522 GtkStyleContext *context,
525 void gtk_style_context_set_screen (GtkStyleContext *context,
527 GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);
529 void gtk_style_context_set_direction (GtkStyleContext *context,
530 GtkTextDirection direction);
531 GtkTextDirection gtk_style_context_get_direction (GtkStyleContext *context);
533 void gtk_style_context_set_junction_sides (GtkStyleContext *context,
534 GtkJunctionSides sides);
535 GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext *context);
537 gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
538 const gchar *color_name,
541 void gtk_style_context_notify_state_change (GtkStyleContext *context,
545 gboolean state_value);
546 void gtk_style_context_cancel_animations (GtkStyleContext *context,
548 void gtk_style_context_scroll_animations (GtkStyleContext *context,
553 void gtk_style_context_push_animatable_region (GtkStyleContext *context,
555 void gtk_style_context_pop_animatable_region (GtkStyleContext *context);
557 /* Some helper functions to retrieve most common properties */
558 void gtk_style_context_get_color (GtkStyleContext *context,
561 void gtk_style_context_get_background_color (GtkStyleContext *context,
564 void gtk_style_context_get_border_color (GtkStyleContext *context,
568 const PangoFontDescription * gtk_style_context_get_font (GtkStyleContext *context,
569 GtkStateFlags state);
571 void gtk_style_context_get_border (GtkStyleContext *context,
574 void gtk_style_context_get_padding (GtkStyleContext *context,
577 void gtk_style_context_get_margin (GtkStyleContext *context,
581 /* Semi-private API */
582 const GValue * _gtk_style_context_peek_style_property (GtkStyleContext *context,
586 void _gtk_style_context_invalidate_animation_areas (GtkStyleContext *context);
587 void _gtk_style_context_coalesce_animation_areas (GtkStyleContext *context,
590 void gtk_style_context_invalidate (GtkStyleContext *context);
591 void gtk_style_context_reset_widgets (GdkScreen *screen);
593 void gtk_style_context_set_background (GtkStyleContext *context,
597 void gtk_render_check (GtkStyleContext *context,
603 void gtk_render_option (GtkStyleContext *context,
609 void gtk_render_arrow (GtkStyleContext *context,
615 void gtk_render_background (GtkStyleContext *context,
621 void gtk_render_frame (GtkStyleContext *context,
627 void gtk_render_expander (GtkStyleContext *context,
633 void gtk_render_focus (GtkStyleContext *context,
639 void gtk_render_layout (GtkStyleContext *context,
643 PangoLayout *layout);
644 void gtk_render_line (GtkStyleContext *context,
650 void gtk_render_slider (GtkStyleContext *context,
656 GtkOrientation orientation);
657 void gtk_render_frame_gap (GtkStyleContext *context,
663 GtkPositionType gap_side,
666 void gtk_render_extension (GtkStyleContext *context,
672 GtkPositionType gap_side);
673 void gtk_render_handle (GtkStyleContext *context,
679 void gtk_render_activity (GtkStyleContext *context,
686 GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext *context,
687 const GtkIconSource *source,
692 #endif /* __GTK_STYLE_CONTEXT_H__ */