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>
35 #define GTK_TYPE_STYLE_CONTEXT (gtk_style_context_get_type ())
36 #define GTK_STYLE_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContext))
37 #define GTK_STYLE_CONTEXT_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))
38 #define GTK_IS_STYLE_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_STYLE_CONTEXT))
39 #define GTK_IS_STYLE_CONTEXT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_STYLE_CONTEXT))
40 #define GTK_STYLE_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))
42 typedef struct _GtkStyleContext GtkStyleContext;
43 typedef struct _GtkStyleContextClass GtkStyleContextClass;
44 typedef struct _GtkStyleContextPrivate GtkStyleContextPrivate;
46 struct _GtkStyleContext
48 GObject parent_object;
49 GtkStyleContextPrivate *priv;
52 struct _GtkStyleContextClass
54 GObjectClass parent_class;
56 void (* changed) (GtkStyleContext *context);
58 /* Padding for future expansion */
59 void (*_gtk_reserved1) (void);
60 void (*_gtk_reserved2) (void);
61 void (*_gtk_reserved3) (void);
62 void (*_gtk_reserved4) (void);
65 /* Default set of properties that GtkStyleContext may contain */
68 * GTK_STYLE_PROPERTY_BACKGROUND_COLOR:
70 * A property holding the background color of rendered elements as a #GdkRGBA.
72 #define GTK_STYLE_PROPERTY_BACKGROUND_COLOR "background-color"
75 * GTK_STYLE_PROPERTY_COLOR:
77 * A property holding the foreground color of rendered elements as a #GdkRGBA.
79 #define GTK_STYLE_PROPERTY_COLOR "color"
82 * GTK_STYLE_PROPERTY_FONT:
84 * A property holding the font properties used when rendering text
85 * as a #PangoFontDescription.
87 #define GTK_STYLE_PROPERTY_FONT "font"
90 * GTK_STYLE_PROPERTY_PADDING:
92 * A property holding the rendered element's padding as a #GtkBorder. The
93 * padding is defined as the spacing between the inner part of the element border
94 * and its child. It's the innermost spacing property of the padding/border/margin
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
103 * a #GtkBorder. The border is the intermediary spacing property of the
104 * padding/border/margin series.
106 * gtk_render_frame() uses this property to find out the frame line width,
107 * so #GtkWidget<!-- -->s rendering frames may need to add up this padding when
110 #define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"
113 * GTK_STYLE_PROPERTY_MARGIN:
115 * A property holding the rendered element's margin as a #GtkBorder. The
116 * margin is defined as the spacing between the border of the element
117 * and its surrounding elements. It is external to #GtkWidget<!-- -->s's
118 * size allocations, and the most external spacing property of the
119 * padding/border/margin series.
121 #define GTK_STYLE_PROPERTY_MARGIN "margin"
124 * GTK_STYLE_PROPERTY_BORDER_RADIUS:
126 * A property holding the rendered element's border radius in pixels as a #gint.
128 #define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"
131 * GTK_STYLE_PROPERTY_BORDER_STYLE:
133 * A property holding the element's border style as a #GtkBorderStyle.
135 #define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"
138 * GTK_STYLE_PROPERTY_BORDER_COLOR:
140 * A property holding the element's border color as a #GdkRGBA.
142 #define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"
145 * GTK_STYLE_PROPERTY_BACKGROUND_IMAGE:
147 * A property holding the element's background as a #cairo_pattern_t.
149 #define GTK_STYLE_PROPERTY_BACKGROUND_IMAGE "background-image"
152 /* Predefined set of CSS classes */
155 * GTK_STYLE_CLASS_CELL:
157 * A CSS class to match content rendered in cell views.
159 * This is used by cell renderers, e.g. in #GtkIconView
162 #define GTK_STYLE_CLASS_CELL "cell"
165 * GTK_STYLE_CLASS_ENTRY:
167 * A CSS class to match text entries.
169 * This is used by #GtkEntry.
171 #define GTK_STYLE_CLASS_ENTRY "entry"
174 * GTK_STYLE_CLASS_BUTTON:
176 * A CSS class to match buttons.
178 * This is used by #GtkButton and its subclasses, as well
179 * as various other widget pieces that appear like buttons,
180 * e.g. the arrows in a #GtkCalendar.
182 #define GTK_STYLE_CLASS_BUTTON "button"
185 * GTK_STYLE_CLASS_CALENDAR:
187 * A CSS class to match calendars.
189 * This is not used by GTK+ itself, currently.
191 #define GTK_STYLE_CLASS_CALENDAR "calendar"
194 * GTK_STYLE_CLASS_SLIDER:
196 * A CSS class to match sliders.
198 * This is used by #GtkSwitch and #GtkRange and its subclasses.
200 #define GTK_STYLE_CLASS_SLIDER "slider"
203 * GTK_STYLE_CLASS_BACKGROUND:
205 * A CSS class to match the window background.
207 #define GTK_STYLE_CLASS_BACKGROUND "background"
210 * GTK_STYLE_CLASS_RUBBERBAND:
212 * A CSS class to match the rubberband selection rectangle.
214 * This is used in #GtkIconView and #GtkTreeView.
216 #define GTK_STYLE_CLASS_RUBBERBAND "rubberband"
219 * GTK_STYLE_CLASS_TOOLTIP:
221 * A CSS class to match tooltip windows.
223 #define GTK_STYLE_CLASS_TOOLTIP "tooltip"
226 * GTK_STYLE_CLASS_MENU:
228 * A CSS class to match popup menus.
230 * This is used in #GtkMenu.
232 #define GTK_STYLE_CLASS_MENU "menu"
235 * GTK_STYLE_CLASS_MENUBAR:
237 * A CSS class to menubars.
239 * This is used in #GtkMenuBar.
241 #define GTK_STYLE_CLASS_MENUBAR "menubar"
244 * GTK_STYLE_CLASS_MENUITEM:
246 * A CSS class to match menu items.
248 * This is used in #GtkMenuItem and its subclasses.
250 #define GTK_STYLE_CLASS_MENUITEM "menuitem"
253 * GTK_STYLE_CLASS_TOOLBAR:
255 * A CSS class to match toolbars.
257 * This is used in #GtkToolbar.
259 #define GTK_STYLE_CLASS_TOOLBAR "toolbar"
262 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
264 * A CSS class to match primary toolbars.
266 * This should be used for the 'main' toolbar of an application,
267 * right below its menubar.
269 #define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"
272 * GTK_STYLE_CLASS_INLINE_TOOLBAR:
274 * A CSS class to match inline toolbars.
276 * This should be used for toolbars that are used to hold
277 * actions below lists, as seen e.g. in the left pane of the
280 #define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"
283 * GTK_STYLE_CLASS_RADIO:
285 * A CSS class to match radio buttons.
287 * This is used in #GtkRadioButton, #GtkRadioMenuItem and
288 * #GtkCellRendererToggle.
290 #define GTK_STYLE_CLASS_RADIO "radio"
293 * GTK_STYLE_CLASS_CHECK:
295 * A CSS class to match check boxes.
297 * This is used in #GtkCheckButton, #GtkCheckMenuItem and
298 * #GtkCellRendererToggle.
300 #define GTK_STYLE_CLASS_CHECK "check"
303 * GTK_STYLE_CLASS_DEFAULT:
305 * A CSS class to match the default widget.
307 * This is used by #GtkButton.
309 #define GTK_STYLE_CLASS_DEFAULT "default"
312 * GTK_STYLE_CLASS_TROUGH:
314 * A CSS class to match troughs, as in scrollbars and progressbars.
316 * This is used in #GtkRange and its subclasses, #GtkProgressBar
319 #define GTK_STYLE_CLASS_TROUGH "trough"
322 * GTK_STYLE_CLASS_SCROLLBAR:
324 * A CSS class to match scrollbars.
326 #define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"
329 * GTK_STYLE_CLASS_SCALE:
331 * A CSS class to match scale widgets.
333 * This is used in #GtkScale.
335 #define GTK_STYLE_CLASS_SCALE "scale"
338 * GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE:
340 * A CSS class to match scale widgets with marks attached,
341 * all the marks are above for horizontal #GtkScale.
342 * left for vertical #GtkScale.
344 #define GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE "scale-has-marks-above"
347 * GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW:
349 * A CSS class to match scale widgets with marks attached,
350 * all the marks are below for horizontal #GtkScale,
351 * right for vertical #GtkScale.
353 #define GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW "scale-has-marks-below"
356 * GTK_STYLE_CLASS_HEADER:
358 * A CSS class to match a header element.
360 * This is used for the header in #GtkCalendar.
362 #define GTK_STYLE_CLASS_HEADER "header"
365 * GTK_STYLE_CLASS_ACCELERATOR:
367 * A CSS class to match an accelerator.
369 * This is used for the accelerator in #GtkAccelLabel.
371 #define GTK_STYLE_CLASS_ACCELERATOR "accelerator"
374 * GTK_STYLE_CLASS_RAISED:
376 * A CSS class to match a raised control, such as a raised
377 * button on a toolbar.
379 * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
381 #define GTK_STYLE_CLASS_RAISED "raised"
384 * GTK_STYLE_CLASS_GRIP:
386 * A CSS class defining a resize grip.
388 * This is used for the resize grip in #GtkWindow.
390 #define GTK_STYLE_CLASS_GRIP "grip"
393 * GTK_STYLE_CLASS_DOCK:
395 * A CSS class defining a dock area.
397 * This is used by #GtkHandleBox.
399 #define GTK_STYLE_CLASS_DOCK "dock"
402 * GTK_STYLE_CLASS_PROGRESSBAR:
404 * A CSS class to use when rendering activity as a progressbar.
406 * This is used in #GtkProgressBar and when drawing progress
407 * inside a #GtkEntry or in #GtkCellRendererProgress.
409 #define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
412 * GTK_STYLE_CLASS_SPINNER:
414 * A CSS class to use when rendering activity as a 'spinner'.
416 * This is used by #GtkSpinner and #GtkCellRendererSpinner.
418 #define GTK_STYLE_CLASS_SPINNER "spinner"
421 * GTK_STYLE_CLASS_MARK:
423 * A CSS class defining marks in a widget, such as in scales.
427 #define GTK_STYLE_CLASS_MARK "mark"
430 * GTK_STYLE_CLASS_EXPANDER:
432 * A CSS class defining an expander, such as those in treeviews.
434 * Used for drawing expanders in #GtkTreeView, GtkExpander and
437 #define GTK_STYLE_CLASS_EXPANDER "expander"
440 * GTK_STYLE_CLASS_SPINBUTTON:
442 * A CSS class defining an spinbutton.
444 * This is used in #GtkSpinButton.
446 #define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"
449 * GTK_STYLE_CLASS_NOTEBOOK:
451 * A CSS class defining a notebook.
453 * Used in #GtkNotebook.
455 #define GTK_STYLE_CLASS_NOTEBOOK "notebook"
458 * GTK_STYLE_CLASS_VIEW:
460 * A CSS class defining a view, such as iconviews or treeviews.
462 * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
463 * as well as #GtkCalendar.
465 #define GTK_STYLE_CLASS_VIEW "view"
468 * GTK_STYLE_CLASS_SIDEBAR:
470 * A CSS class defining a sidebar, such as the left side in
473 * This is used in #GtkFileChooser and in #GtkAssistant.
475 #define GTK_STYLE_CLASS_SIDEBAR "sidebar"
478 * GTK_STYLE_CLASS_IMAGE:
480 * A CSS class defining an image, such as the icon in an entry.
482 * This is used when rendering icons in #GtkEntry.
484 #define GTK_STYLE_CLASS_IMAGE "image"
487 * GTK_STYLE_CLASS_HIGHLIGHT:
489 * A CSS class defining a highlighted area, such as headings in
490 * assistants and calendars.
492 * This is used in #GtkAssistant and #GtkCalendar.
494 #define GTK_STYLE_CLASS_HIGHLIGHT "highlight"
497 * GTK_STYLE_CLASS_FRAME:
499 * A CSS class defining a frame delimiting content, such as
500 * #GtkFrame or the scrolled window frame around the
503 * This is used in #GtkFrame and #GtkScrollbar.
505 #define GTK_STYLE_CLASS_FRAME "frame"
508 * GTK_STYLE_CLASS_DND:
510 * A CSS class for a drag-and-drop indicator.
512 * This is used when drawing an outline around a potential
513 * drop target during DND.
515 #define GTK_STYLE_CLASS_DND "dnd"
518 * GTK_STYLE_CLASS_PANE_SEPARATOR:
520 * A CSS class for a pane separator, such as those in #GtkPaned.
524 #define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"
527 * GTK_STYLE_CLASS_SEPARATOR:
529 * A CSS class for a separator.
531 * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
532 * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
534 #define GTK_STYLE_CLASS_SEPARATOR "separator"
537 * GTK_STYLE_CLASS_INFO:
539 * A CSS class for an area displaying an informational message,
540 * such as those in infobars.
542 * This is used by #GtkInfoBar.
544 #define GTK_STYLE_CLASS_INFO "info"
547 * GTK_STYLE_CLASS_WARNING:
549 * A CSS class for an area displaying a warning message,
550 * such as those in infobars.
552 * This is used by #GtkInfoBar.
554 #define GTK_STYLE_CLASS_WARNING "warning"
557 * GTK_STYLE_CLASS_QUESTION:
559 * A CSS class for an area displaying a question to the user,
560 * such as those in infobars.
562 * This is used by #GtkInfoBar.
564 #define GTK_STYLE_CLASS_QUESTION "question"
567 * GTK_STYLE_CLASS_ERROR:
569 * A CSS class for an area displaying an error message,
570 * such as those in infobars.
572 * This is used by #GtkInfoBar.
574 #define GTK_STYLE_CLASS_ERROR "error"
577 * GTK_STYLE_CLASS_HORIZONTAL:
579 * A CSS class for horizontally layered widgets.
581 * This is used by widgets implementing #GtkOrientable.
583 #define GTK_STYLE_CLASS_HORIZONTAL "horizontal"
586 * GTK_STYLE_CLASS_VERTICAL:
588 * A CSS class for vertically layered widgets.
590 * This is used by widgets implementing #GtkOrientable.
592 #define GTK_STYLE_CLASS_VERTICAL "vertical"
595 /* Predefined set of widget regions */
598 * GTK_STYLE_REGION_ROW:
600 * A widget region name to define a treeview row.
602 #define GTK_STYLE_REGION_ROW "row"
605 * GTK_STYLE_REGION_COLUMN:
607 * A widget region name to define a treeview column.
609 #define GTK_STYLE_REGION_COLUMN "column"
612 * GTK_STYLE_REGION_COLUMN_HEADER:
614 * A widget region name to define a treeview column header.
616 #define GTK_STYLE_REGION_COLUMN_HEADER "column-header"
619 * GTK_STYLE_REGION_TAB:
621 * A widget region name to define a notebook tab.
623 #define GTK_STYLE_REGION_TAB "tab"
626 GType gtk_style_context_get_type (void) G_GNUC_CONST;
628 GtkStyleContext * gtk_style_context_new (void);
630 void gtk_style_context_add_provider_for_screen (GdkScreen *screen,
631 GtkStyleProvider *provider,
633 void gtk_style_context_remove_provider_for_screen (GdkScreen *screen,
634 GtkStyleProvider *provider);
636 void gtk_style_context_add_provider (GtkStyleContext *context,
637 GtkStyleProvider *provider,
640 void gtk_style_context_remove_provider (GtkStyleContext *context,
641 GtkStyleProvider *provider);
643 void gtk_style_context_save (GtkStyleContext *context);
644 void gtk_style_context_restore (GtkStyleContext *context);
646 void gtk_style_context_get_property (GtkStyleContext *context,
647 const gchar *property,
650 void gtk_style_context_get_valist (GtkStyleContext *context,
653 void gtk_style_context_get (GtkStyleContext *context,
655 ...) G_GNUC_NULL_TERMINATED;
657 void gtk_style_context_set_state (GtkStyleContext *context,
658 GtkStateFlags flags);
659 GtkStateFlags gtk_style_context_get_state (GtkStyleContext *context);
661 gboolean gtk_style_context_state_is_running (GtkStyleContext *context,
665 void gtk_style_context_set_path (GtkStyleContext *context,
666 GtkWidgetPath *path);
667 const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
669 GList * gtk_style_context_list_classes (GtkStyleContext *context);
671 void gtk_style_context_add_class (GtkStyleContext *context,
672 const gchar *class_name);
673 void gtk_style_context_remove_class (GtkStyleContext *context,
674 const gchar *class_name);
675 gboolean gtk_style_context_has_class (GtkStyleContext *context,
676 const gchar *class_name);
678 GList * gtk_style_context_list_regions (GtkStyleContext *context);
680 void gtk_style_context_add_region (GtkStyleContext *context,
681 const gchar *region_name,
682 GtkRegionFlags flags);
683 void gtk_style_context_remove_region (GtkStyleContext *context,
684 const gchar *region_name);
685 gboolean gtk_style_context_has_region (GtkStyleContext *context,
686 const gchar *region_name,
687 GtkRegionFlags *flags_return);
689 void gtk_style_context_get_style_property (GtkStyleContext *context,
690 const gchar *property_name,
692 void gtk_style_context_get_style_valist (GtkStyleContext *context,
694 void gtk_style_context_get_style (GtkStyleContext *context,
697 GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
698 const gchar *stock_id);
699 GdkPixbuf * gtk_icon_set_render_icon_pixbuf (GtkIconSet *icon_set,
700 GtkStyleContext *context,
703 void gtk_style_context_set_screen (GtkStyleContext *context,
705 GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);
707 void gtk_style_context_set_direction (GtkStyleContext *context,
708 GtkTextDirection direction);
709 GtkTextDirection gtk_style_context_get_direction (GtkStyleContext *context);
711 void gtk_style_context_set_junction_sides (GtkStyleContext *context,
712 GtkJunctionSides sides);
713 GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext *context);
715 gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
716 const gchar *color_name,
719 void gtk_style_context_notify_state_change (GtkStyleContext *context,
723 gboolean state_value);
724 void gtk_style_context_cancel_animations (GtkStyleContext *context,
726 void gtk_style_context_scroll_animations (GtkStyleContext *context,
731 void gtk_style_context_push_animatable_region (GtkStyleContext *context,
733 void gtk_style_context_pop_animatable_region (GtkStyleContext *context);
735 /* Some helper functions to retrieve most common properties */
736 void gtk_style_context_get_color (GtkStyleContext *context,
739 void gtk_style_context_get_background_color (GtkStyleContext *context,
742 void gtk_style_context_get_border_color (GtkStyleContext *context,
745 const PangoFontDescription *
746 gtk_style_context_get_font (GtkStyleContext *context,
747 GtkStateFlags state);
748 void gtk_style_context_get_border (GtkStyleContext *context,
751 void gtk_style_context_get_padding (GtkStyleContext *context,
754 void gtk_style_context_get_margin (GtkStyleContext *context,
758 void gtk_style_context_invalidate (GtkStyleContext *context);
759 void gtk_style_context_reset_widgets (GdkScreen *screen);
761 void gtk_style_context_set_background (GtkStyleContext *context,
765 void gtk_render_check (GtkStyleContext *context,
771 void gtk_render_option (GtkStyleContext *context,
777 void gtk_render_arrow (GtkStyleContext *context,
783 void gtk_render_background (GtkStyleContext *context,
789 void gtk_render_frame (GtkStyleContext *context,
795 void gtk_render_expander (GtkStyleContext *context,
801 void gtk_render_focus (GtkStyleContext *context,
807 void gtk_render_layout (GtkStyleContext *context,
811 PangoLayout *layout);
812 void gtk_render_line (GtkStyleContext *context,
818 void gtk_render_slider (GtkStyleContext *context,
824 GtkOrientation orientation);
825 void gtk_render_frame_gap (GtkStyleContext *context,
831 GtkPositionType gap_side,
834 void gtk_render_extension (GtkStyleContext *context,
840 GtkPositionType gap_side);
841 void gtk_render_handle (GtkStyleContext *context,
847 void gtk_render_activity (GtkStyleContext *context,
853 GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext *context,
854 const GtkIconSource *source,
856 void gtk_render_icon (GtkStyleContext *context,
862 /* Accessibility support */
863 AtkAttributeSet *_gtk_style_context_get_attributes (AtkAttributeSet *attributes,
864 GtkStyleContext *context,
865 GtkStateFlags flags);
869 #endif /* __GTK_STYLE_CONTEXT_H__ */