gtkstylecontext.h 35.4 KB
Newer Older
Carlos Garnacho's avatar
Carlos Garnacho committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GTK - The GIMP Toolkit
 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Carlos Garnacho's avatar
Carlos Garnacho committed
16 17
 */

18 19 20
#ifndef __GTK_STYLE_CONTEXT_H__
#define __GTK_STYLE_CONTEXT_H__

21 22 23 24
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

25
#include <gtk/gtkborder.h>
26
#include <gtk/gtkcsssection.h>
27
#include <gtk/gtkstyleprovider.h>
28
#include <gtk/gtktypes.h>
29
#include <atk/atk.h>
Carlos Garnacho's avatar
Carlos Garnacho committed
30 31 32 33 34 35 36 37 38 39

G_BEGIN_DECLS

#define GTK_TYPE_STYLE_CONTEXT         (gtk_style_context_get_type ())
#define GTK_STYLE_CONTEXT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContext))
#define GTK_STYLE_CONTEXT_CLASS(c)     (G_TYPE_CHECK_CLASS_CAST    ((c), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))
#define GTK_IS_STYLE_CONTEXT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_STYLE_CONTEXT))
#define GTK_IS_STYLE_CONTEXT_CLASS(c)  (G_TYPE_CHECK_CLASS_TYPE    ((c), GTK_TYPE_STYLE_CONTEXT))
#define GTK_STYLE_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS  ((o), GTK_TYPE_STYLE_CONTEXT, GtkStyleContextClass))

40
typedef struct _GtkStyleContextClass GtkStyleContextClass;
41
typedef struct _GtkStyleContextPrivate GtkStyleContextPrivate;
Carlos Garnacho's avatar
Carlos Garnacho committed
42

43
struct _GtkStyleContext
Carlos Garnacho's avatar
Carlos Garnacho committed
44 45
{
  GObject parent_object;
46
  GtkStyleContextPrivate *priv;
Carlos Garnacho's avatar
Carlos Garnacho committed
47 48
};

49
struct _GtkStyleContextClass
Carlos Garnacho's avatar
Carlos Garnacho committed
50 51
{
  GObjectClass parent_class;
52 53

  void (* changed) (GtkStyleContext *context);
54 55 56 57 58 59

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Carlos Garnacho's avatar
Carlos Garnacho committed
60 61
};

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
/* Default set of properties that GtkStyleContext may contain */

/**
 * GTK_STYLE_PROPERTY_BACKGROUND_COLOR:
 *
 * A property holding the background color of rendered elements as a #GdkRGBA.
 */
#define GTK_STYLE_PROPERTY_BACKGROUND_COLOR "background-color"

/**
 * GTK_STYLE_PROPERTY_COLOR:
 *
 * A property holding the foreground color of rendered elements as a #GdkRGBA.
 */
#define GTK_STYLE_PROPERTY_COLOR "color"

/**
 * GTK_STYLE_PROPERTY_FONT:
 *
 * A property holding the font properties used when rendering text
 * as a #PangoFontDescription.
 */
#define GTK_STYLE_PROPERTY_FONT "font"

/**
 * GTK_STYLE_PROPERTY_PADDING:
 *
 * A property holding the rendered element's padding as a #GtkBorder. The
 * padding is defined as the spacing between the inner part of the element border
91 92
 * and its child. It's the innermost spacing property of the padding/border/margin
 * series.
93 94 95 96 97 98
 */
#define GTK_STYLE_PROPERTY_PADDING "padding"

/**
 * GTK_STYLE_PROPERTY_BORDER_WIDTH:
 *
99 100 101 102 103 104 105
 * A property holding the rendered element's border width in pixels as
 * a #GtkBorder. The border is the intermediary spacing property of the
 * padding/border/margin series.
 *
 * gtk_render_frame() uses this property to find out the frame line width,
 * so #GtkWidget<!-- -->s rendering frames may need to add up this padding when
 * requesting size
106 107 108
 */
#define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"

109 110 111 112 113 114 115 116 117 118 119
/**
 * GTK_STYLE_PROPERTY_MARGIN:
 *
 * A property holding the rendered element's margin as a #GtkBorder. The
 * margin is defined as the spacing between the border of the element
 * and its surrounding elements. It is external to #GtkWidget<!-- -->s's
 * size allocations, and the most external spacing property of the
 * padding/border/margin series.
 */
#define GTK_STYLE_PROPERTY_MARGIN "margin"

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
/**
 * GTK_STYLE_PROPERTY_BORDER_RADIUS:
 *
 * A property holding the rendered element's border radius in pixels as a #gint.
 */
#define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"

/**
 * GTK_STYLE_PROPERTY_BORDER_STYLE:
 *
 * A property holding the element's border style as a #GtkBorderStyle.
 */
#define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"

/**
 * GTK_STYLE_PROPERTY_BORDER_COLOR:
 *
 * A property holding the element's border color as a #GdkRGBA.
 */
#define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"

/**
 * GTK_STYLE_PROPERTY_BACKGROUND_IMAGE:
 *
 * A property holding the element's background as a #cairo_pattern_t.
 */
#define GTK_STYLE_PROPERTY_BACKGROUND_IMAGE "background-image"

148 149 150 151 152 153
/* Predefined set of CSS classes */

/**
 * GTK_STYLE_CLASS_CELL:
 *
 * A CSS class to match content rendered in cell views.
154 155 156
 *
 * This is used by cell renderers, e.g. in #GtkIconView
 * and #GtkTreeView.
157 158 159
 */
#define GTK_STYLE_CLASS_CELL "cell"

160 161 162 163 164 165 166 167 168 169
/**
 * GTK_STYLE_CLASS_DIM_LABEL:
 *
 * A CSS class to match dimmed labels.
 *
 * This should be used for toning down right aligned labels as
 * compared to the entry value.
 */
#define GTK_STYLE_CLASS_DIM_LABEL "dim-label"

170 171 172 173
/**
 * GTK_STYLE_CLASS_ENTRY:
 *
 * A CSS class to match text entries.
174 175
 *
 * This is used by #GtkEntry.
176 177 178
 */
#define GTK_STYLE_CLASS_ENTRY "entry"

179 180 181 182 183 184 185 186 187
/**
 * GTK_STYLE_CLASS_COMBOBOX_ENTRY:
 *
 * A CSS class to match combobox entries.
 *
 * This is used by #GtkComboBox.
 */
#define GTK_STYLE_CLASS_COMBOBOX_ENTRY "combobox-entry"

188 189 190 191
/**
 * GTK_STYLE_CLASS_BUTTON:
 *
 * A CSS class to match buttons.
192 193 194 195
 *
 * This is used by #GtkButton and its subclasses, as well
 * as various other widget pieces that appear like buttons,
 * e.g. the arrows in a #GtkCalendar.
196 197 198
 */
#define GTK_STYLE_CLASS_BUTTON "button"

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
/**
 * GTK_STYLE_CLASS_LIST:
 *
 * A CSS class to match lists.
 *
 * This is used by #GtkListBox.
 */
#define GTK_STYLE_CLASS_LIST "list"

/**
 * GTK_STYLE_CLASS_LIST_ROW:
 *
 * A CSS class to match list rowss.
 *
 * This is used by #GtkListBoxRow.
 */
#define GTK_STYLE_CLASS_LIST_ROW "list-row"

217 218 219 220
/**
 * GTK_STYLE_CLASS_CALENDAR:
 *
 * A CSS class to match calendars.
221 222
 *
 * This is not used by GTK+ itself, currently.
223 224 225 226 227 228 229
 */
#define GTK_STYLE_CLASS_CALENDAR "calendar"

/**
 * GTK_STYLE_CLASS_SLIDER:
 *
 * A CSS class to match sliders.
230 231
 *
 * This is used by #GtkSwitch and #GtkRange and its subclasses.
232 233 234 235 236 237 238 239 240 241 242 243 244 245
 */
#define GTK_STYLE_CLASS_SLIDER "slider"

/**
 * GTK_STYLE_CLASS_BACKGROUND:
 *
 * A CSS class to match the window background.
 */
#define GTK_STYLE_CLASS_BACKGROUND "background"

/**
 * GTK_STYLE_CLASS_RUBBERBAND:
 *
 * A CSS class to match the rubberband selection rectangle.
246 247
 *
 * This is used in #GtkIconView and #GtkTreeView.
248 249 250 251 252 253 254 255 256 257 258 259 260 261
 */
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"

/**
 * GTK_STYLE_CLASS_TOOLTIP:
 *
 * A CSS class to match tooltip windows.
 */
#define GTK_STYLE_CLASS_TOOLTIP "tooltip"

/**
 * GTK_STYLE_CLASS_MENU:
 *
 * A CSS class to match popup menus.
262 263
 *
 * This is used in #GtkMenu.
264 265 266
 */
#define GTK_STYLE_CLASS_MENU "menu"

267 268 269 270
/**
 * GTK_STYLE_CLASS_MENUBAR:
 *
 * A CSS class to menubars.
271 272
 *
 * This is used in #GtkMenuBar.
273 274 275 276 277 278 279
 */
#define GTK_STYLE_CLASS_MENUBAR "menubar"

/**
 * GTK_STYLE_CLASS_MENUITEM:
 *
 * A CSS class to match menu items.
280 281
 *
 * This is used in #GtkMenuItem and its subclasses.
282 283 284
 */
#define GTK_STYLE_CLASS_MENUITEM "menuitem"

285 286 287 288
/**
 * GTK_STYLE_CLASS_TOOLBAR:
 *
 * A CSS class to match toolbars.
289 290
 *
 * This is used in #GtkToolbar.
291 292 293
 */
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"

294 295 296 297
/**
 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
 *
 * A CSS class to match primary toolbars.
298 299 300
 *
 * This should be used for the 'main' toolbar of an application,
 * right below its menubar.
301 302 303
 */
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"

304 305 306 307
/**
 * GTK_STYLE_CLASS_INLINE_TOOLBAR:
 *
 * A CSS class to match inline toolbars.
308 309 310 311
 *
 * This should be used for toolbars that are used to hold
 * actions below lists, as seen e.g. in the left pane of the
 * file chooser.
312 313 314
 */
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"

315 316 317 318
/**
 * GTK_STYLE_CLASS_RADIO:
 *
 * A CSS class to match radio buttons.
319 320 321
 *
 * This is used in #GtkRadioButton, #GtkRadioMenuItem and
 * #GtkCellRendererToggle.
322 323 324 325 326 327 328
 */
#define GTK_STYLE_CLASS_RADIO "radio"

/**
 * GTK_STYLE_CLASS_CHECK:
 *
 * A CSS class to match check boxes.
329 330 331
 *
 * This is used in #GtkCheckButton, #GtkCheckMenuItem and
 * #GtkCellRendererToggle.
332 333 334 335 336 337 338
 */
#define GTK_STYLE_CLASS_CHECK "check"

/**
 * GTK_STYLE_CLASS_DEFAULT:
 *
 * A CSS class to match the default widget.
339 340
 *
 * This is used by #GtkButton.
341 342 343 344 345 346 347
 */
#define GTK_STYLE_CLASS_DEFAULT "default"

/**
 * GTK_STYLE_CLASS_TROUGH:
 *
 * A CSS class to match troughs, as in scrollbars and progressbars.
348 349 350
 *
 * This is used in #GtkRange and its subclasses, #GtkProgressBar
 * and #GtkSwitch.
351 352 353 354 355 356 357 358 359 360
 */
#define GTK_STYLE_CLASS_TROUGH "trough"

/**
 * GTK_STYLE_CLASS_SCROLLBAR:
 *
 * A CSS class to match scrollbars.
 */
#define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"

361 362 363 364 365 366 367 368 369 370
/**
 * GTK_STYLE_CLASS_SCROLLBARS_JUNCTION:
 *
 * A CSS class to match the junction area between an horizontal
 * and vertical scrollbar, when they're both shown.
 * 
 * This is used in #GtkScrolledWindow.
 */
#define GTK_STYLE_CLASS_SCROLLBARS_JUNCTION "scrollbars-junction"

371 372 373 374
/**
 * GTK_STYLE_CLASS_SCALE:
 *
 * A CSS class to match scale widgets.
375 376
 *
 * This is used in #GtkScale.
377 378 379
 */
#define GTK_STYLE_CLASS_SCALE "scale"

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
/**
 * GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE:
 *
 * A CSS class to match scale widgets with marks attached,
 * all the marks are above for horizontal #GtkScale.
 * left for vertical #GtkScale.
 */
#define GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE "scale-has-marks-above"

/**
 * GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW:
 *
 * A CSS class to match scale widgets with marks attached,
 * all the marks are below for horizontal #GtkScale,
 * right for vertical #GtkScale.
 */
#define GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW "scale-has-marks-below"

398 399 400 401
/**
 * GTK_STYLE_CLASS_HEADER:
 *
 * A CSS class to match a header element.
402 403
 *
 * This is used for the header in #GtkCalendar.
404 405 406
 */
#define GTK_STYLE_CLASS_HEADER "header"

407 408 409 410
/**
 * GTK_STYLE_CLASS_ACCELERATOR:
 *
 * A CSS class to match an accelerator.
411 412
 *
 * This is used for the accelerator in #GtkAccelLabel.
413 414 415
 */
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"

416 417 418 419 420
/**
 * GTK_STYLE_CLASS_RAISED:
 *
 * A CSS class to match a raised control, such as a raised
 * button on a toolbar.
421 422
 *
 * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
423 424 425
 */
#define GTK_STYLE_CLASS_RAISED "raised"

426 427 428 429 430 431 432 433
/**
 * GTK_STYLE_CLASS_LINKED:
 *
 * A CSS class to match a linked area, such as a box containing buttons
 * belonging to the same control.
 */
#define GTK_STYLE_CLASS_LINKED "linked"

434 435 436
/**
 * GTK_STYLE_CLASS_GRIP:
 *
437 438 439
 * A CSS class defining a resize grip.
 *
 * This is used for the resize grip in #GtkWindow.
440 441 442
 */
#define GTK_STYLE_CLASS_GRIP "grip"

443 444 445
/**
 * GTK_STYLE_CLASS_DOCK:
 *
446 447 448
 * A CSS class defining a dock area.
 *
 * This is used by #GtkHandleBox.
449 450 451
 */
#define GTK_STYLE_CLASS_DOCK "dock"

452 453 454
/**
 * GTK_STYLE_CLASS_PROGRESSBAR:
 *
455 456 457 458
 * A CSS class to use when rendering activity as a progressbar.
 *
 * This is used in #GtkProgressBar and when drawing progress
 * inside a #GtkEntry or in #GtkCellRendererProgress.
459 460
 */
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
461

462 463 464
/**
 * GTK_STYLE_CLASS_SPINNER:
 *
465 466 467
 * A CSS class to use when rendering activity as a 'spinner'.
 *
 * This is used by #GtkSpinner and #GtkCellRendererSpinner.
468 469 470
 */
#define GTK_STYLE_CLASS_SPINNER "spinner"

471 472 473
/**
 * GTK_STYLE_CLASS_MARK:
 *
474 475 476
 * A CSS class defining marks in a widget, such as in scales.
 *
 * Used in #GtkScale.
477 478 479
 */
#define GTK_STYLE_CLASS_MARK "mark"

480 481 482
/**
 * GTK_STYLE_CLASS_EXPANDER:
 *
483 484 485 486
 * A CSS class defining an expander, such as those in treeviews.
 *
 * Used for drawing expanders in #GtkTreeView, GtkExpander and
 * #GtkToolItemGroup.
487 488 489
 */
#define GTK_STYLE_CLASS_EXPANDER "expander"

490 491 492
/**
 * GTK_STYLE_CLASS_SPINBUTTON:
 *
493 494 495
 * A CSS class defining an spinbutton.
 *
 * This is used in #GtkSpinButton.
496 497 498
 */
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"

499 500 501
/**
 * GTK_STYLE_CLASS_NOTEBOOK:
 *
502 503 504
 * A CSS class defining a notebook.
 *
 * Used in #GtkNotebook.
505 506 507
 */
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"

508 509 510
/**
 * GTK_STYLE_CLASS_VIEW:
 *
511 512 513 514
 * A CSS class defining a view, such as iconviews or treeviews.
 *
 * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
 * as well as #GtkCalendar.
515 516 517
 */
#define GTK_STYLE_CLASS_VIEW "view"

518 519 520
/**
 * GTK_STYLE_CLASS_SIDEBAR:
 *
521 522 523 524
 * A CSS class defining a sidebar, such as the left side in
 * a file chooser.
 *
 * This is used in #GtkFileChooser and in #GtkAssistant.
525 526 527
 */
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"

528 529 530
/**
 * GTK_STYLE_CLASS_IMAGE:
 *
531 532 533
 * A CSS class defining an image, such as the icon in an entry.
 *
 * This is used when rendering icons in #GtkEntry.
534 535 536
 */
#define GTK_STYLE_CLASS_IMAGE "image"

537 538 539 540
/**
 * GTK_STYLE_CLASS_HIGHLIGHT:
 *
 * A CSS class defining a highlighted area, such as headings in
541 542 543
 * assistants and calendars.
 *
 * This is used in #GtkAssistant and #GtkCalendar.
544 545 546
 */
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"

547 548 549
/**
 * GTK_STYLE_CLASS_FRAME:
 *
550 551 552 553 554
 * A CSS class defining a frame delimiting content, such as
 * #GtkFrame or the scrolled window frame around the
 * scrollable area.
 *
 * This is used in #GtkFrame and #GtkScrollbar.
555 556 557
 */
#define GTK_STYLE_CLASS_FRAME "frame"

558 559 560
/**
 * GTK_STYLE_CLASS_DND:
 *
561 562 563 564
 * A CSS class for a drag-and-drop indicator.
 *
 * This is used when drawing an outline around a potential
 * drop target during DND.
565 566 567
 */
#define GTK_STYLE_CLASS_DND "dnd"

568 569 570 571
/**
 * GTK_STYLE_CLASS_PANE_SEPARATOR:
 *
 * A CSS class for a pane separator, such as those in #GtkPaned.
572 573
 *
 * Used in #GtkPaned.
574 575 576
 */
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"

577 578 579 580
/**
 * GTK_STYLE_CLASS_SEPARATOR:
 *
 * A CSS class for a separator.
581 582 583
 *
 * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
 * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
584 585 586
 */
#define GTK_STYLE_CLASS_SEPARATOR "separator"

587 588 589
/**
 * GTK_STYLE_CLASS_INFO:
 *
590 591 592 593
 * A CSS class for an area displaying an informational message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
594 595 596 597 598 599
 */
#define GTK_STYLE_CLASS_INFO "info"

/**
 * GTK_STYLE_CLASS_WARNING:
 *
600 601 602 603
 * A CSS class for an area displaying a warning message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
604 605 606 607 608 609
 */
#define GTK_STYLE_CLASS_WARNING "warning"

/**
 * GTK_STYLE_CLASS_QUESTION:
 *
610 611 612 613
 * A CSS class for an area displaying a question to the user,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
614 615 616 617 618 619
 */
#define GTK_STYLE_CLASS_QUESTION "question"

/**
 * GTK_STYLE_CLASS_ERROR:
 *
620 621 622 623
 * A CSS class for an area displaying an error message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
624 625 626
 */
#define GTK_STYLE_CLASS_ERROR "error"

627 628 629
/**
 * GTK_STYLE_CLASS_HORIZONTAL:
 *
630 631 632
 * A CSS class for horizontally layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
633 634 635 636 637 638
 */
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"

/**
 * GTK_STYLE_CLASS_VERTICAL:
 *
639 640 641
 * A CSS class for vertically layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
642 643 644
 */
#define GTK_STYLE_CLASS_VERTICAL "vertical"

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
/**
 * GTK_STYLE_CLASS_TOP:
 *
 * A CSS class to indicate an area at the top of a widget.
 *
 * This is used by widgets that can render an area in different
 * positions, such as tabs in a #GtkNotebook.
 */
#define GTK_STYLE_CLASS_TOP "top"

/**
 * GTK_STYLE_CLASS_BOTTOM:
 *
 * A CSS class to indicate an area at the bottom of a widget.
 *
 * This is used by widgets that can render an area in different
 * positions, such as tabs in a #GtkNotebook.
 */
#define GTK_STYLE_CLASS_BOTTOM "bottom"

/**
 * GTK_STYLE_CLASS_LEFT:
 *
 * A CSS class to indicate an area at the left of a widget.
 *
 * This is used by widgets that can render an area in different
 * positions, such as tabs in a #GtkNotebook.
 */
#define GTK_STYLE_CLASS_LEFT "left"

/**
 * GTK_STYLE_CLASS_RIGHT:
 *
 * A CSS class to indicate an area at the right of a widget.
 *
 * This is used by widgets that can render an area in different
 * positions, such as tabs in a #GtkNotebook.
 */
#define GTK_STYLE_CLASS_RIGHT "right"
684

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
/**
 * GTK_STYLE_CLASS_PULSE:
 *
 * A CSS class to use when rendering a pulse in an indeterminate progress bar.
 *
 * This is used by #GtkProgressBar and #GtkEntry.
 */
#define GTK_STYLE_CLASS_PULSE "pulse"

/**
 * GTK_STYLE_CLASS_ARROW:
 *
 * A CSS class used when rendering an arrow element.
 *
 * Note that #gtk_render_arrow automatically adds this style class
 * to the style context when rendering an arrow element.
 */
#define GTK_STYLE_CLASS_ARROW "arrow"

704 705 706 707 708 709 710 711
/**
 * GTK_STYLE_CLASS_OSD:
 *
 * A CSS class used when rendering an OSD (On Screen Display) element,
 * on top of another container.
 */
#define GTK_STYLE_CLASS_OSD "osd"

712 713 714 715 716 717 718 719 720 721
/**
 * GTK_STYLE_CLASS_LEVEL_BAR:
 *
 * A CSS class used when rendering a level indicator, such
 * as a battery charge level, or a password strength.
 *
 * This is used by #GtkLevelBar.
 */
#define GTK_STYLE_CLASS_LEVEL_BAR "level-bar"

Carlos Garnacho's avatar
Carlos Garnacho committed
722 723 724 725 726 727 728 729
/**
 * GTK_STYLE_CLASS_CURSOR_HANDLE:
 *
 * A CSS class used when rendering a drag handle for
 * text selection.
 */
#define GTK_STYLE_CLASS_CURSOR_HANDLE "cursor-handle"

730 731 732 733 734 735 736 737 738
/**
 * GTK_STYLE_CLASS_INSERTION_CURSOR:
 *
 * A CSS class used when rendering a drag handle for
 * the insertion cursor position.
 */
#define GTK_STYLE_CLASS_INSERTION_CURSOR "insertion-cursor"


739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
/* Predefined set of widget regions */

/**
 * GTK_STYLE_REGION_ROW:
 *
 * A widget region name to define a treeview row.
 */
#define GTK_STYLE_REGION_ROW "row"

/**
 * GTK_STYLE_REGION_COLUMN:
 *
 * A widget region name to define a treeview column.
 */
#define GTK_STYLE_REGION_COLUMN "column"

/**
 * GTK_STYLE_REGION_COLUMN_HEADER:
 *
 * A widget region name to define a treeview column header.
 */
#define GTK_STYLE_REGION_COLUMN_HEADER "column-header"

/**
 * GTK_STYLE_REGION_TAB:
 *
 * A widget region name to define a notebook tab.
 */
#define GTK_STYLE_REGION_TAB "tab"

769
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
770 771
GType gtk_style_context_get_type (void) G_GNUC_CONST;

772
GDK_AVAILABLE_IN_ALL
773 774
GtkStyleContext * gtk_style_context_new (void);

775
GDK_AVAILABLE_IN_ALL
776 777 778
void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
                                                   GtkStyleProvider *provider,
                                                   guint             priority);
779
GDK_AVAILABLE_IN_ALL
780 781 782
void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
                                                   GtkStyleProvider *provider);

783
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
784 785 786 787
void gtk_style_context_add_provider    (GtkStyleContext  *context,
                                        GtkStyleProvider *provider,
                                        guint             priority);

788
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
789 790 791
void gtk_style_context_remove_provider (GtkStyleContext  *context,
                                        GtkStyleProvider *provider);

792
GDK_AVAILABLE_IN_ALL
793
void gtk_style_context_save    (GtkStyleContext *context);
794
GDK_AVAILABLE_IN_ALL
795 796
void gtk_style_context_restore (GtkStyleContext *context);

797
GDK_AVAILABLE_IN_ALL
798 799
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context,
                                               const gchar     *property);
800
GDK_AVAILABLE_IN_ALL
801 802
void gtk_style_context_get_property (GtkStyleContext *context,
                                     const gchar     *property,
803
                                     GtkStateFlags    state,
804
                                     GValue          *value);
805
GDK_AVAILABLE_IN_ALL
806
void gtk_style_context_get_valist   (GtkStyleContext *context,
807
                                     GtkStateFlags    state,
808
                                     va_list          args);
809
GDK_AVAILABLE_IN_ALL
810
void gtk_style_context_get          (GtkStyleContext *context,
811
                                     GtkStateFlags    state,
812 813
                                     ...) G_GNUC_NULL_TERMINATED;

814
GDK_AVAILABLE_IN_ALL
815 816
void          gtk_style_context_set_state    (GtkStyleContext *context,
                                              GtkStateFlags    flags);
817
GDK_AVAILABLE_IN_ALL
818 819
GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);

820 821 822 823 824 825
GDK_AVAILABLE_IN_3_10
void          gtk_style_context_set_scale    (GtkStyleContext *context,
                                              gint             scale);
GDK_AVAILABLE_IN_3_10
gint          gtk_style_context_get_scale    (GtkStyleContext *context);

826
GDK_DEPRECATED_IN_3_6
827 828 829
gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
                                                  GtkStateType     state,
                                                  gdouble         *progress);
830

831
GDK_AVAILABLE_IN_ALL
832 833
void          gtk_style_context_set_path     (GtkStyleContext *context,
                                              GtkWidgetPath   *path);
834
GDK_AVAILABLE_IN_ALL
835
const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
836
GDK_AVAILABLE_IN_3_4
837 838
void          gtk_style_context_set_parent   (GtkStyleContext *context,
                                              GtkStyleContext *parent);
839
GDK_AVAILABLE_IN_ALL
840 841
GtkStyleContext *gtk_style_context_get_parent (GtkStyleContext *context);

842
GDK_AVAILABLE_IN_ALL
843 844
GList *  gtk_style_context_list_classes (GtkStyleContext *context);

845
GDK_AVAILABLE_IN_ALL
846 847
void     gtk_style_context_add_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
848
GDK_AVAILABLE_IN_ALL
849 850
void     gtk_style_context_remove_class (GtkStyleContext *context,
                                         const gchar     *class_name);
851
GDK_AVAILABLE_IN_ALL
852 853
gboolean gtk_style_context_has_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
854

855
GDK_AVAILABLE_IN_ALL
856 857
GList *  gtk_style_context_list_regions (GtkStyleContext *context);

858
GDK_AVAILABLE_IN_ALL
859 860 861
void     gtk_style_context_add_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags      flags);
862
GDK_AVAILABLE_IN_ALL
863 864
void     gtk_style_context_remove_region (GtkStyleContext    *context,
                                          const gchar        *region_name);
865
GDK_AVAILABLE_IN_ALL
866 867 868
gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags     *flags_return);
869

870
GDK_AVAILABLE_IN_ALL
871 872 873
void gtk_style_context_get_style_property (GtkStyleContext *context,
                                           const gchar     *property_name,
                                           GValue          *value);
874
GDK_AVAILABLE_IN_ALL
875 876
void gtk_style_context_get_style_valist   (GtkStyleContext *context,
                                           va_list          args);
877
GDK_AVAILABLE_IN_ALL
878 879
void gtk_style_context_get_style          (GtkStyleContext *context,
                                           ...);
880

881
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_lookup_icon)
882
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
883
                                                const gchar     *stock_id);
884
GDK_DEPRECATED_IN_3_10
885 886 887
GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
                                                GtkStyleContext *context,
                                                GtkIconSize      size);
888 889 890 891 892 893 894
GDK_AVAILABLE_IN_3_10
cairo_surface_t  *
gtk_icon_set_render_icon_surface               (GtkIconSet      *icon_set,
						GtkStyleContext *context,
						GtkIconSize      size,
						int              scale,
						GdkWindow       *for_window);
895

896
GDK_AVAILABLE_IN_ALL
897 898
void        gtk_style_context_set_screen (GtkStyleContext *context,
                                          GdkScreen       *screen);
899
GDK_AVAILABLE_IN_ALL
900 901
GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);

902 903 904 905 906 907 908
GDK_AVAILABLE_IN_3_8
void           gtk_style_context_set_frame_clock (GtkStyleContext *context,
                                                  GdkFrameClock   *frame_clock);
GDK_AVAILABLE_IN_3_8
GdkFrameClock *gtk_style_context_get_frame_clock (GtkStyleContext *context);


909
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_set_state)
910 911
void             gtk_style_context_set_direction (GtkStyleContext  *context,
                                                  GtkTextDirection  direction);
912
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get_state)
913 914
GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);

915
GDK_AVAILABLE_IN_ALL
916
void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
917
                                                       GtkJunctionSides  sides);
918
GDK_AVAILABLE_IN_ALL
919 920
GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);

921
GDK_AVAILABLE_IN_ALL
922 923 924
gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
                                         const gchar     *color_name,
                                         GdkRGBA         *color);
925

926
GDK_DEPRECATED_IN_3_6
927 928 929 930 931
void  gtk_style_context_notify_state_change (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gpointer         region_id,
                                             GtkStateType     state,
                                             gboolean         state_value);
932
GDK_DEPRECATED_IN_3_6
933 934
void  gtk_style_context_cancel_animations   (GtkStyleContext *context,
                                             gpointer         region_id);
935
GDK_DEPRECATED_IN_3_6
936 937 938 939
void  gtk_style_context_scroll_animations   (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gint             dx,
                                             gint             dy);
940

941
GDK_DEPRECATED_IN_3_6
942 943
void gtk_style_context_push_animatable_region (GtkStyleContext *context,
                                               gpointer         region_id);
944
GDK_DEPRECATED_IN_3_6
945 946
void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);

947
/* Some helper functions to retrieve most common properties */
948
GDK_AVAILABLE_IN_ALL
949 950 951
void gtk_style_context_get_color            (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
952
GDK_AVAILABLE_IN_ALL
953 954 955
void gtk_style_context_get_background_color (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
956
GDK_AVAILABLE_IN_ALL
957 958 959
void gtk_style_context_get_border_color     (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
960 961

GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get)
962 963 964
const PangoFontDescription *
     gtk_style_context_get_font             (GtkStyleContext *context,
                                             GtkStateFlags    state);
965
GDK_AVAILABLE_IN_ALL
966 967 968
void gtk_style_context_get_border           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *border);
969
GDK_AVAILABLE_IN_ALL
970 971 972
void gtk_style_context_get_padding          (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *padding);
973
GDK_AVAILABLE_IN_ALL
974 975 976
void gtk_style_context_get_margin           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *margin);
977

978
GDK_AVAILABLE_IN_ALL
979
void gtk_style_context_invalidate           (GtkStyleContext *context);
980
GDK_AVAILABLE_IN_ALL
981
void gtk_style_context_reset_widgets        (GdkScreen       *screen);
982

983
GDK_AVAILABLE_IN_ALL
984 985
void gtk_style_context_set_background       (GtkStyleContext *context,
                                             GdkWindow       *window);
986

987
/* Paint methods */
988
GDK_AVAILABLE_IN_ALL
989 990 991 992 993 994
void        gtk_render_check       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
995
GDK_AVAILABLE_IN_ALL
996 997 998 999 1000 1001
void        gtk_render_option      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1002
GDK_AVAILABLE_IN_ALL
1003 1004 1005 1006 1007 1008
void        gtk_render_arrow       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              angle,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              size);
1009
GDK_AVAILABLE_IN_ALL
1010 1011 1012 1013 1014 1015
void        gtk_render_background  (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1016
GDK_AVAILABLE_IN_ALL
1017 1018 1019 1020 1021 1022
void        gtk_render_frame       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1023
GDK_AVAILABLE_IN_ALL
1024 1025 1026 1027 1028 1029
void        gtk_render_expander    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1030
GDK_AVAILABLE_IN_ALL
1031 1032 1033 1034 1035 1036
void        gtk_render_focus       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1037
GDK_AVAILABLE_IN_ALL
1038 1039 1040 1041 1042
void        gtk_render_layout      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout);
1043
GDK_AVAILABLE_IN_ALL
1044 1045 1046 1047 1048 1049
void        gtk_render_line        (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x0,
                                    gdouble              y0,
                                    gdouble              x1,
                                    gdouble              y1);
1050
GDK_AVAILABLE_IN_ALL
1051 1052 1053 1054 1055 1056 1057
void        gtk_render_slider      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkOrientation       orientation);
1058
GDK_AVAILABLE_IN_ALL
1059 1060 1061 1062 1063 1064 1065 1066 1067
void        gtk_render_frame_gap   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkPositionType      gap_side,
                                    gdouble              xy0_gap,
                                    gdouble              xy1_gap);
1068
GDK_AVAILABLE_IN_ALL
1069 1070 1071 1072 1073 1074 1075
void        gtk_render_extension   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkPositionType      gap_side);
1076
GDK_AVAILABLE_IN_ALL
1077 1078 1079 1080 1081 1082
void        gtk_render_handle      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1083
GDK_AVAILABLE_IN_ALL
1084 1085 1086 1087 1088 1089
void        gtk_render_activity    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1090
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_load_icon)
1091 1092 1093
GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext     *context,
                                    const GtkIconSource *source,
                                    GtkIconSize          size);
1094
GDK_AVAILABLE_IN_3_2
1095 1096
void        gtk_render_icon        (GtkStyleContext     *context,
                                    cairo_t             *cr,
1097
                                    GdkPixbuf           *pixbuf,
1098 1099
                                    gdouble              x,
                                    gdouble              y);
1100 1101 1102 1103 1104 1105
GDK_AVAILABLE_IN_3_10
void        gtk_render_icon_surface (GtkStyleContext    *context,
				     cairo_t            *cr,
				     cairo_surface_t    *surface,
				     gdouble             x,
				     gdouble             y);
1106
GDK_AVAILABLE_IN_3_4
1107 1108 1109 1110 1111 1112 1113 1114
void        gtk_render_insertion_cursor
                                   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout,
                                    int                  index,
                                    PangoDirection       direction);
1115
GDK_DEPRECATED_IN_3_4
1116 1117 1118 1119 1120 1121 1122
void   gtk_draw_insertion_cursor    (GtkWidget          *widget,
                                     cairo_t            *cr,
                                     const GdkRectangle *location,
                                     gboolean            is_primary,
                                     GtkTextDirection    direction,
                                     gboolean            draw_arrow);

1123 1124 1125 1126 1127
/* Accessibility support */
AtkAttributeSet *_gtk_style_context_get_attributes (AtkAttributeSet *attributes,
                                                    GtkStyleContext *context,
                                                    GtkStateFlags    flags);

Carlos Garnacho's avatar
Carlos Garnacho committed
1128 1129 1130
G_END_DECLS

#endif /* __GTK_STYLE_CONTEXT_H__ */