Pileus Git - ~andy/gtk/blob - 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_NOTEBOOK:
 314  *
 315  * A widget class defining a notebook
 316  */
 317 #define GTK_STYLE_CLASS_NOTEBOOK "notebook"
 318
 319
 320 /* Predefined set of widget regions */
 321
 322 /**
 323  * GTK_STYLE_REGION_ROW:
 324  *
 325  * A widget region name to define a treeview row.
 326  */
 327 #define GTK_STYLE_REGION_ROW "row"
 328
 329 /**
 330  * GTK_STYLE_REGION_COLUMN:
 331  *
 332  * A widget region name to define a treeview column.
 333  */
 334 #define GTK_STYLE_REGION_COLUMN "column"
 335
 336 /**
 337  * GTK_STYLE_REGION_COLUMN_HEADER:
 338  *
 339  * A widget region name to define a treeview column header.
 340  */
 341 #define GTK_STYLE_REGION_COLUMN_HEADER "column-header"
 342
 343 /**
 344  * GTK_STYLE_REGION_TAB:
 345  *
 346  * A widget region name to define a notebook tab.
 347  */
 348 #define GTK_STYLE_REGION_TAB "tab"
 349
 350
 351 GType gtk_style_context_get_type (void) G_GNUC_CONST;
 352
 353 GtkStyleContext * gtk_style_context_new (void);
 354
 355 void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
 356                                                    GtkStyleProvider *provider,
 357                                                    guint             priority);
 358 void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
 359                                                    GtkStyleProvider *provider);
 360
 361 void gtk_style_context_add_provider    (GtkStyleContext  *context,
 362                                         GtkStyleProvider *provider,
 363                                         guint             priority);
 364
 365 void gtk_style_context_remove_provider (GtkStyleContext  *context,
 366                                         GtkStyleProvider *provider);
 367
 368 void gtk_style_context_save    (GtkStyleContext *context);
 369 void gtk_style_context_restore (GtkStyleContext *context);
 370
 371 void gtk_style_context_get_property (GtkStyleContext *context,
 372                                      const gchar     *property,
 373                                      GtkStateFlags    state,
 374                                      GValue          *value);
 375 void gtk_style_context_get_valist   (GtkStyleContext *context,
 376                                      GtkStateFlags    state,
 377                                      va_list          args);
 378 void gtk_style_context_get          (GtkStyleContext *context,
 379                                      GtkStateFlags    state,
 380                                      ...) G_GNUC_NULL_TERMINATED;
 381
 382 void          gtk_style_context_set_state    (GtkStyleContext *context,
 383                                               GtkStateFlags    flags);
 384 GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);
 385
 386 gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
 387                                                   GtkStateType     state,
 388                                                   gdouble         *progress);
 389
 390 void          gtk_style_context_set_path     (GtkStyleContext *context,
 391                                               GtkWidgetPath   *path);
 392 G_CONST_RETURN GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
 393
 394 GList *  gtk_style_context_list_classes (GtkStyleContext *context);
 395
 396 void     gtk_style_context_add_class    (GtkStyleContext *context,
 397                                          const gchar     *class_name);
 398 void     gtk_style_context_remove_class (GtkStyleContext *context,
 399                                          const gchar     *class_name);
 400 gboolean gtk_style_context_has_class    (GtkStyleContext *context,
 401                                          const gchar     *class_name);
 402
 403 GList *  gtk_style_context_list_regions (GtkStyleContext *context);
 404
 405 void     gtk_style_context_add_region    (GtkStyleContext    *context,
 406                                           const gchar        *region_name,
 407                                           GtkRegionFlags      flags);
 408 void     gtk_style_context_remove_region (GtkStyleContext    *context,
 409                                           const gchar        *region_name);
 410 gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
 411                                           const gchar        *region_name,
 412                                           GtkRegionFlags     *flags_return);
 413
 414 void gtk_style_context_get_style_property (GtkStyleContext *context,
 415                                            const gchar     *property_name,
 416                                            GValue          *value);
 417 void gtk_style_context_get_style_valist   (GtkStyleContext *context,
 418                                            va_list          args);
 419 void gtk_style_context_get_style          (GtkStyleContext *context,
 420                                            ...);
 421
 422 GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
 423                                                 const gchar     *stock_id);
 424 GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
 425                                                 GtkStyleContext *context,
 426                                                 GtkIconSize      size);
 427
 428 void        gtk_style_context_set_screen (GtkStyleContext *context,
 429                                           GdkScreen       *screen);
 430 GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);
 431
 432 void             gtk_style_context_set_direction (GtkStyleContext  *context,
 433                                                   GtkTextDirection  direction);
 434 GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);
 435
 436 void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
 437                                                        GtkJunctionSides  sides);
 438 GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);
 439
 440 gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
 441                                          const gchar     *color_name,
 442                                          GdkRGBA         *color);
 443
 444 void  gtk_style_context_notify_state_change (GtkStyleContext *context,
 445                                              GdkWindow       *window,
 446                                              gpointer         region_id,
 447                                              GtkStateType     state,
 448                                              gboolean         state_value);
 449 void gtk_style_context_push_animatable_region (GtkStyleContext *context,
 450                                                gpointer         region_id);
 451 void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);
 452
 453 /* Some helper functions to retrieve most common properties */
 454 void gtk_style_context_get_color            (GtkStyleContext *context,
 455                                              GtkStateFlags    state,
 456                                              GdkRGBA         *color);
 457 void gtk_style_context_get_background_color (GtkStyleContext *context,
 458                                              GtkStateFlags    state,
 459                                              GdkRGBA         *color);
 460 void gtk_style_context_get_border_color     (GtkStyleContext *context,
 461                                              GtkStateFlags    state,
 462                                              GdkRGBA         *color);
 463
 464 const PangoFontDescription * gtk_style_context_get_font (GtkStyleContext *context,
 465                                                     GtkStateFlags    state);
 466
 467 void gtk_style_context_get_border           (GtkStyleContext *context,
 468                                              GtkStateFlags    state,
 469                                              GtkBorder       *border);
 470 void gtk_style_context_get_padding          (GtkStyleContext *context,
 471                                              GtkStateFlags    state,
 472                                              GtkBorder       *padding);
 473 void gtk_style_context_get_margin           (GtkStyleContext *context,
 474                                              GtkStateFlags    state,
 475                                              GtkBorder       *margin);
 476
 477 /* Semi-private API */
 478 const GValue * _gtk_style_context_peek_style_property (GtkStyleContext *context,
 479                                                        GType            widget_type,
 480                                                        GtkStateFlags    state,
 481                                                        GParamSpec      *pspec);
 482 void           _gtk_style_context_invalidate_animation_areas (GtkStyleContext *context);
 483 void           _gtk_style_context_coalesce_animation_areas   (GtkStyleContext *context,
 484                                                               GtkWidget       *widget);
 485
 486 void gtk_style_context_invalidate (GtkStyleContext *context);
 487 void gtk_style_context_reset_widgets (GdkScreen *screen);
 488
 489 void gtk_style_context_set_background (GtkStyleContext *context,
 490                                        GdkWindow       *window);
 491
 492 /* Paint methods */
 493 void gtk_render_check (GtkStyleContext *context,
 494                        cairo_t         *cr,
 495                        gdouble          x,
 496                        gdouble          y,
 497                        gdouble          width,
 498                        gdouble          height);
 499 void gtk_render_option (GtkStyleContext *context,
 500                         cairo_t         *cr,
 501                         gdouble          x,
 502                         gdouble          y,
 503                         gdouble          width,
 504                         gdouble          height);
 505 void gtk_render_arrow  (GtkStyleContext *context,
 506                         cairo_t         *cr,
 507                         gdouble          angle,
 508                         gdouble          x,
 509                         gdouble          y,
 510                         gdouble          size);
 511 void gtk_render_background (GtkStyleContext *context,
 512                             cairo_t         *cr,
 513                             gdouble          x,
 514                             gdouble          y,
 515                             gdouble          width,
 516                             gdouble          height);
 517 void gtk_render_frame  (GtkStyleContext *context,
 518                         cairo_t         *cr,
 519                         gdouble          x,
 520                         gdouble          y,
 521                         gdouble          width,
 522                         gdouble          height);
 523 void gtk_render_expander (GtkStyleContext *context,
 524                           cairo_t         *cr,
 525                           gdouble          x,
 526                           gdouble          y,
 527                           gdouble          width,
 528                           gdouble          height);
 529 void gtk_render_focus    (GtkStyleContext *context,
 530                           cairo_t         *cr,
 531                           gdouble          x,
 532                           gdouble          y,
 533                           gdouble          width,
 534                           gdouble          height);
 535 void gtk_render_layout   (GtkStyleContext *context,
 536                           cairo_t         *cr,
 537                           gdouble          x,
 538                           gdouble          y,
 539                           PangoLayout     *layout);
 540 void gtk_render_line     (GtkStyleContext *context,
 541                           cairo_t         *cr,
 542                           gdouble          x0,
 543                           gdouble          y0,
 544                           gdouble          x1,
 545                           gdouble          y1);
 546 void gtk_render_slider   (GtkStyleContext *context,
 547                           cairo_t         *cr,
 548                           gdouble          x,
 549                           gdouble          y,
 550                           gdouble          width,
 551                           gdouble          height,
 552                           GtkOrientation   orientation);
 553 void gtk_render_frame_gap (GtkStyleContext *context,
 554                            cairo_t         *cr,
 555                            gdouble          x,
 556                            gdouble          y,
 557                            gdouble          width,
 558                            gdouble          height,
 559                            GtkPositionType  gap_side,
 560                            gdouble          xy0_gap,
 561                            gdouble          xy1_gap);
 562 void gtk_render_extension (GtkStyleContext *context,
 563                            cairo_t         *cr,
 564                            gdouble          x,
 565                            gdouble          y,
 566                            gdouble          width,
 567                            gdouble          height,
 568                            GtkPositionType  gap_side);
 569 void gtk_render_handle    (GtkStyleContext *context,
 570                            cairo_t         *cr,
 571                            gdouble          x,
 572                            gdouble          y,
 573                            gdouble          width,
 574                            gdouble          height);
 575 void gtk_render_activity  (GtkStyleContext *context,
 576                            cairo_t         *cr,
 577                            gdouble          x,
 578                            gdouble          y,
 579                            gdouble          width,
 580                            gdouble          height);
 581
 582 GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext     *context,
 583                                     const GtkIconSource *source,
 584                                     GtkIconSize          size);
 585
 586 G_END_DECLS
 587
 588 #endif /* __GTK_STYLE_CONTEXT_H__ */