gtkstylecontext.h 36.9 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
/* 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:
 *
89
 * A property holding the rendered element’s padding as a #GtkBorder. The
90
 * padding is defined as the spacing between the inner part of the element border
91
 * and its child. It’s the innermost spacing property of the padding/border/margin
92
 * series.
93 94 95 96 97 98
 */
#define GTK_STYLE_PROPERTY_PADDING "padding"

/**
 * GTK_STYLE_PROPERTY_BORDER_WIDTH:
 *
99
 * A property holding the rendered element’s border width in pixels as
100 101 102 103
 * 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,
104
 * so #GtkWidgets rendering frames may need to add up this padding when
105
 * requesting size
106 107 108
 */
#define GTK_STYLE_PROPERTY_BORDER_WIDTH "border-width"

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

120 121 122
/**
 * GTK_STYLE_PROPERTY_BORDER_RADIUS:
 *
123
 * A property holding the rendered element’s border radius in pixels as a #gint.
124 125 126 127 128 129
 */
#define GTK_STYLE_PROPERTY_BORDER_RADIUS "border-radius"

/**
 * GTK_STYLE_PROPERTY_BORDER_STYLE:
 *
130
 * A property holding the element’s border style as a #GtkBorderStyle.
131 132 133 134 135 136
 */
#define GTK_STYLE_PROPERTY_BORDER_STYLE "border-style"

/**
 * GTK_STYLE_PROPERTY_BORDER_COLOR:
 *
137
 * A property holding the element’s border color as a #GdkRGBA.
138 139 140 141 142 143
 */
#define GTK_STYLE_PROPERTY_BORDER_COLOR "border-color"

/**
 * GTK_STYLE_PROPERTY_BACKGROUND_IMAGE:
 *
144
 * A property holding the element’s background as a #cairo_pattern_t.
145 146 147
 */
#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
 */
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"

Matthias Clasen's avatar
Matthias Clasen committed
251 252 253 254 255 256 257 258 259 260
/**
 * GTK_STYLE_CLASS_CSD:
 *
 * A CSS class that gets added to windows which have
 * client-side decorations.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_CSD "csd"

261 262 263 264 265 266 267 268 269 270
/**
 * GTK_STYLE_CLASS_TOOLTIP:
 *
 * A CSS class to match tooltip windows.
 */
#define GTK_STYLE_CLASS_TOOLTIP "tooltip"

/**
 * GTK_STYLE_CLASS_MENU:
 *
271
 * A CSS class to match menus.
272 273
 *
 * This is used in #GtkMenu.
274 275 276
 */
#define GTK_STYLE_CLASS_MENU "menu"

277 278 279 280 281 282 283 284 285 286 287
/**
 * GTK_STYLE_CLASS_CONTEXT_MENU:
 *
 * A CSS class to match context menus.
 *
 * This style class is useful when you want to prevent
 * a context menu from inheriting e.g. font changes from
 * the widget it is attached to.
 */
#define GTK_STYLE_CLASS_CONTEXT_MENU "context-menu"

288 289 290 291
/**
 * GTK_STYLE_CLASS_MENUBAR:
 *
 * A CSS class to menubars.
292 293
 *
 * This is used in #GtkMenuBar.
294 295 296 297 298 299 300
 */
#define GTK_STYLE_CLASS_MENUBAR "menubar"

/**
 * GTK_STYLE_CLASS_MENUITEM:
 *
 * A CSS class to match menu items.
301 302
 *
 * This is used in #GtkMenuItem and its subclasses.
303 304 305
 */
#define GTK_STYLE_CLASS_MENUITEM "menuitem"

306 307 308 309
/**
 * GTK_STYLE_CLASS_TOOLBAR:
 *
 * A CSS class to match toolbars.
310 311
 *
 * This is used in #GtkToolbar.
312 313 314
 */
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"

315 316 317 318
/**
 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
 *
 * A CSS class to match primary toolbars.
319
 *
320
 * This should be used for the “main” toolbar of an application,
321
 * right below its menubar.
322 323 324
 */
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"

325 326 327 328
/**
 * GTK_STYLE_CLASS_INLINE_TOOLBAR:
 *
 * A CSS class to match inline toolbars.
329 330 331 332
 *
 * 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.
333 334 335
 */
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"

336 337 338 339
/**
 * GTK_STYLE_CLASS_RADIO:
 *
 * A CSS class to match radio buttons.
340 341 342
 *
 * This is used in #GtkRadioButton, #GtkRadioMenuItem and
 * #GtkCellRendererToggle.
343 344 345 346 347 348 349
 */
#define GTK_STYLE_CLASS_RADIO "radio"

/**
 * GTK_STYLE_CLASS_CHECK:
 *
 * A CSS class to match check boxes.
350 351 352
 *
 * This is used in #GtkCheckButton, #GtkCheckMenuItem and
 * #GtkCellRendererToggle.
353 354 355 356 357 358 359
 */
#define GTK_STYLE_CLASS_CHECK "check"

/**
 * GTK_STYLE_CLASS_DEFAULT:
 *
 * A CSS class to match the default widget.
360 361
 *
 * This is used by #GtkButton.
362 363 364 365 366 367 368
 */
#define GTK_STYLE_CLASS_DEFAULT "default"

/**
 * GTK_STYLE_CLASS_TROUGH:
 *
 * A CSS class to match troughs, as in scrollbars and progressbars.
369 370 371
 *
 * This is used in #GtkRange and its subclasses, #GtkProgressBar
 * and #GtkSwitch.
372 373 374 375 376 377 378 379 380 381
 */
#define GTK_STYLE_CLASS_TROUGH "trough"

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

382 383 384 385
/**
 * GTK_STYLE_CLASS_SCROLLBARS_JUNCTION:
 *
 * A CSS class to match the junction area between an horizontal
386
 * and vertical scrollbar, when they’re both shown.
387 388 389 390 391
 * 
 * This is used in #GtkScrolledWindow.
 */
#define GTK_STYLE_CLASS_SCROLLBARS_JUNCTION "scrollbars-junction"

392 393 394 395
/**
 * GTK_STYLE_CLASS_SCALE:
 *
 * A CSS class to match scale widgets.
396 397
 *
 * This is used in #GtkScale.
398 399 400
 */
#define GTK_STYLE_CLASS_SCALE "scale"

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
/**
 * 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"

419 420 421 422
/**
 * GTK_STYLE_CLASS_HEADER:
 *
 * A CSS class to match a header element.
423 424
 *
 * This is used for the header in #GtkCalendar.
425 426 427
 */
#define GTK_STYLE_CLASS_HEADER "header"

428 429 430 431
/**
 * GTK_STYLE_CLASS_ACCELERATOR:
 *
 * A CSS class to match an accelerator.
432 433
 *
 * This is used for the accelerator in #GtkAccelLabel.
434 435 436
 */
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"

437 438 439 440 441
/**
 * GTK_STYLE_CLASS_RAISED:
 *
 * A CSS class to match a raised control, such as a raised
 * button on a toolbar.
442 443
 *
 * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
444 445 446
 */
#define GTK_STYLE_CLASS_RAISED "raised"

447 448 449 450 451 452 453 454
/**
 * 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"

455 456 457
/**
 * GTK_STYLE_CLASS_GRIP:
 *
458 459 460
 * A CSS class defining a resize grip.
 *
 * This is used for the resize grip in #GtkWindow.
461 462 463
 */
#define GTK_STYLE_CLASS_GRIP "grip"

464 465 466
/**
 * GTK_STYLE_CLASS_DOCK:
 *
467 468 469
 * A CSS class defining a dock area.
 *
 * This is used by #GtkHandleBox.
470 471 472
 */
#define GTK_STYLE_CLASS_DOCK "dock"

473 474 475
/**
 * GTK_STYLE_CLASS_PROGRESSBAR:
 *
476 477 478 479
 * 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.
480 481
 */
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
482

483 484 485
/**
 * GTK_STYLE_CLASS_SPINNER:
 *
486
 * A CSS class to use when rendering activity as a “spinner”.
487 488
 *
 * This is used by #GtkSpinner and #GtkCellRendererSpinner.
489 490 491
 */
#define GTK_STYLE_CLASS_SPINNER "spinner"

492 493 494
/**
 * GTK_STYLE_CLASS_MARK:
 *
495 496 497
 * A CSS class defining marks in a widget, such as in scales.
 *
 * Used in #GtkScale.
498 499 500
 */
#define GTK_STYLE_CLASS_MARK "mark"

501 502 503
/**
 * GTK_STYLE_CLASS_EXPANDER:
 *
504 505 506 507
 * A CSS class defining an expander, such as those in treeviews.
 *
 * Used for drawing expanders in #GtkTreeView, GtkExpander and
 * #GtkToolItemGroup.
508 509 510
 */
#define GTK_STYLE_CLASS_EXPANDER "expander"

511 512 513
/**
 * GTK_STYLE_CLASS_SPINBUTTON:
 *
514 515 516
 * A CSS class defining an spinbutton.
 *
 * This is used in #GtkSpinButton.
517 518 519
 */
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"

520 521 522
/**
 * GTK_STYLE_CLASS_NOTEBOOK:
 *
523 524 525
 * A CSS class defining a notebook.
 *
 * Used in #GtkNotebook.
526 527 528
 */
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"

529 530 531
/**
 * GTK_STYLE_CLASS_VIEW:
 *
532 533 534 535
 * A CSS class defining a view, such as iconviews or treeviews.
 *
 * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
 * as well as #GtkCalendar.
536 537 538
 */
#define GTK_STYLE_CLASS_VIEW "view"

539 540 541
/**
 * GTK_STYLE_CLASS_SIDEBAR:
 *
542 543 544 545
 * A CSS class defining a sidebar, such as the left side in
 * a file chooser.
 *
 * This is used in #GtkFileChooser and in #GtkAssistant.
546 547 548
 */
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"

549 550 551
/**
 * GTK_STYLE_CLASS_IMAGE:
 *
552 553 554
 * A CSS class defining an image, such as the icon in an entry.
 *
 * This is used when rendering icons in #GtkEntry.
555 556 557
 */
#define GTK_STYLE_CLASS_IMAGE "image"

558 559 560 561
/**
 * GTK_STYLE_CLASS_HIGHLIGHT:
 *
 * A CSS class defining a highlighted area, such as headings in
562 563 564
 * assistants and calendars.
 *
 * This is used in #GtkAssistant and #GtkCalendar.
565 566 567
 */
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"

568 569 570
/**
 * GTK_STYLE_CLASS_FRAME:
 *
571 572 573 574 575
 * 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.
576 577 578
 */
#define GTK_STYLE_CLASS_FRAME "frame"

579 580 581
/**
 * GTK_STYLE_CLASS_DND:
 *
582 583 584 585
 * A CSS class for a drag-and-drop indicator.
 *
 * This is used when drawing an outline around a potential
 * drop target during DND.
586 587 588
 */
#define GTK_STYLE_CLASS_DND "dnd"

589 590 591 592
/**
 * GTK_STYLE_CLASS_PANE_SEPARATOR:
 *
 * A CSS class for a pane separator, such as those in #GtkPaned.
593 594
 *
 * Used in #GtkPaned.
595 596 597
 */
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"

598 599 600 601
/**
 * GTK_STYLE_CLASS_SEPARATOR:
 *
 * A CSS class for a separator.
602 603 604
 *
 * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
 * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
605 606 607
 */
#define GTK_STYLE_CLASS_SEPARATOR "separator"

608 609 610
/**
 * GTK_STYLE_CLASS_INFO:
 *
611 612 613 614
 * A CSS class for an area displaying an informational message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
615 616 617 618 619 620
 */
#define GTK_STYLE_CLASS_INFO "info"

/**
 * GTK_STYLE_CLASS_WARNING:
 *
621 622 623 624
 * A CSS class for an area displaying a warning message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
625 626 627 628 629 630
 */
#define GTK_STYLE_CLASS_WARNING "warning"

/**
 * GTK_STYLE_CLASS_QUESTION:
 *
631 632 633 634
 * A CSS class for an area displaying a question to the user,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
635 636 637 638 639 640
 */
#define GTK_STYLE_CLASS_QUESTION "question"

/**
 * GTK_STYLE_CLASS_ERROR:
 *
641 642 643 644
 * A CSS class for an area displaying an error message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
645 646 647
 */
#define GTK_STYLE_CLASS_ERROR "error"

648 649 650
/**
 * GTK_STYLE_CLASS_HORIZONTAL:
 *
651 652 653
 * A CSS class for horizontally layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
654 655 656 657 658 659
 */
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"

/**
 * GTK_STYLE_CLASS_VERTICAL:
 *
660 661 662
 * A CSS class for vertically layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
663 664 665
 */
#define GTK_STYLE_CLASS_VERTICAL "vertical"

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
/**
 * 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"
705

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
/**
 * 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"

725 726 727 728 729 730 731 732
/**
 * 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"

733 734 735 736 737 738 739 740 741 742
/**
 * 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
743 744 745 746 747 748 749 750
/**
 * 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"

751 752 753 754 755 756 757 758
/**
 * 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"

759 760 761 762 763 764 765
/**
 * GTK_STYLE_CLASS_TITLEBAR:
 *
 * A CSS class used when rendering a titlebar in a toplevel
 * window.
 */
#define GTK_STYLE_CLASS_TITLEBAR "titlebar"
766

767 768 769 770 771 772 773 774 775 776 777
/**
 * GTK_STYLE_CLASS_NEEDS_ATTENTION:
 *
 * A CSS class used when an element needs the user attention,
 * for instance a button in a stack switcher corresponding to
 * a hidden page that changed state.
*
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_NEEDS_ATTENTION "needs-attention"

778 779 780 781 782 783 784 785 786 787
/**
 * GTK_STYLE_CLASS_SUGGESTED_ACTION:
 *
 * A CSS class used when an action (usually a button) is the
 * primary suggested action in a specific context.
 *
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_SUGGESTED_ACTION "suggested-action"

788 789 790 791 792 793 794 795 796 797 798
/**
 * GTK_STYLE_CLASS_DESTRUCTIVE_ACTION:
 *
 * A CSS class used when an action (usually a button) is
 * one that is expected to remove or destroy something visible
 * to the user.
 *
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_DESTRUCTIVE_ACTION "destructive-action"

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
/* 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"

829
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
830 831
GType gtk_style_context_get_type (void) G_GNUC_CONST;

832
GDK_AVAILABLE_IN_ALL
833 834
GtkStyleContext * gtk_style_context_new (void);

835
GDK_AVAILABLE_IN_ALL
836 837 838
void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
                                                   GtkStyleProvider *provider,
                                                   guint             priority);
839
GDK_AVAILABLE_IN_ALL
840 841 842
void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
                                                   GtkStyleProvider *provider);

843
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
844 845 846 847
void gtk_style_context_add_provider    (GtkStyleContext  *context,
                                        GtkStyleProvider *provider,
                                        guint             priority);

848
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
849 850 851
void gtk_style_context_remove_provider (GtkStyleContext  *context,
                                        GtkStyleProvider *provider);

852
GDK_AVAILABLE_IN_ALL
853
void gtk_style_context_save    (GtkStyleContext *context);
854
GDK_AVAILABLE_IN_ALL
855 856
void gtk_style_context_restore (GtkStyleContext *context);

857
GDK_AVAILABLE_IN_ALL
858 859
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context,
                                               const gchar     *property);
860
GDK_AVAILABLE_IN_ALL
861 862
void gtk_style_context_get_property (GtkStyleContext *context,
                                     const gchar     *property,
863
                                     GtkStateFlags    state,
864
                                     GValue          *value);
865
GDK_AVAILABLE_IN_ALL
866
void gtk_style_context_get_valist   (GtkStyleContext *context,
867
                                     GtkStateFlags    state,
868
                                     va_list          args);
869
GDK_AVAILABLE_IN_ALL
870
void gtk_style_context_get          (GtkStyleContext *context,
871
                                     GtkStateFlags    state,
872 873
                                     ...) G_GNUC_NULL_TERMINATED;

874
GDK_AVAILABLE_IN_ALL
875 876
void          gtk_style_context_set_state    (GtkStyleContext *context,
                                              GtkStateFlags    flags);
877
GDK_AVAILABLE_IN_ALL
878 879
GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);

880 881 882 883 884 885
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);

886
GDK_DEPRECATED_IN_3_6
887 888 889
gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
                                                  GtkStateType     state,
                                                  gdouble         *progress);
890

891
GDK_AVAILABLE_IN_ALL
892 893
void          gtk_style_context_set_path     (GtkStyleContext *context,
                                              GtkWidgetPath   *path);
894
GDK_AVAILABLE_IN_ALL
895
const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
896
GDK_AVAILABLE_IN_3_4
897 898
void          gtk_style_context_set_parent   (GtkStyleContext *context,
                                              GtkStyleContext *parent);
899
GDK_AVAILABLE_IN_ALL
900 901
GtkStyleContext *gtk_style_context_get_parent (GtkStyleContext *context);

902
GDK_AVAILABLE_IN_ALL
903 904
GList *  gtk_style_context_list_classes (GtkStyleContext *context);

905
GDK_AVAILABLE_IN_ALL
906 907
void     gtk_style_context_add_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
908
GDK_AVAILABLE_IN_ALL
909 910
void     gtk_style_context_remove_class (GtkStyleContext *context,
                                         const gchar     *class_name);
911
GDK_AVAILABLE_IN_ALL
912 913
gboolean gtk_style_context_has_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
914

915
GDK_AVAILABLE_IN_ALL
916 917
GList *  gtk_style_context_list_regions (GtkStyleContext *context);

918
GDK_AVAILABLE_IN_ALL
919 920 921
void     gtk_style_context_add_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags      flags);
922
GDK_AVAILABLE_IN_ALL
923 924
void     gtk_style_context_remove_region (GtkStyleContext    *context,
                                          const gchar        *region_name);
925
GDK_AVAILABLE_IN_ALL
926 927 928
gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags     *flags_return);
929

930
GDK_AVAILABLE_IN_ALL
931 932 933
void gtk_style_context_get_style_property (GtkStyleContext *context,
                                           const gchar     *property_name,
                                           GValue          *value);
934
GDK_AVAILABLE_IN_ALL
935 936
void gtk_style_context_get_style_valist   (GtkStyleContext *context,
                                           va_list          args);
937
GDK_AVAILABLE_IN_ALL
938 939
void gtk_style_context_get_style          (GtkStyleContext *context,
                                           ...);
940

941
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_lookup_icon)
942
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
943
                                                const gchar     *stock_id);
944
GDK_DEPRECATED_IN_3_10
945 946 947
GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
                                                GtkStyleContext *context,
                                                GtkIconSize      size);
948
GDK_DEPRECATED_IN_3_10
949 950 951 952 953 954
cairo_surface_t  *
gtk_icon_set_render_icon_surface               (GtkIconSet      *icon_set,
						GtkStyleContext *context,
						GtkIconSize      size,
						int              scale,
						GdkWindow       *for_window);
955

956
GDK_AVAILABLE_IN_ALL
957 958
void        gtk_style_context_set_screen (GtkStyleContext *context,
                                          GdkScreen       *screen);
959
GDK_AVAILABLE_IN_ALL
960 961
GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);

962 963 964 965 966 967
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);

968 969 970 971 972 973
/**
 * GTK_STYLE_CLASS_READ_ONLY:
 *
 * A CSS class used to indicate a read-only state.
 */
#define GTK_STYLE_CLASS_READ_ONLY "read-only"
974

975
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_set_state)
976 977
void             gtk_style_context_set_direction (GtkStyleContext  *context,
                                                  GtkTextDirection  direction);
978
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get_state)
979 980
GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);

981
GDK_AVAILABLE_IN_ALL
982
void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
983
                                                       GtkJunctionSides  sides);
984
GDK_AVAILABLE_IN_ALL
985 986
GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);

987
GDK_AVAILABLE_IN_ALL
988 989 990
gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
                                         const gchar     *color_name,
                                         GdkRGBA         *color);
991

992
GDK_DEPRECATED_IN_3_6
993 994 995 996 997
void  gtk_style_context_notify_state_change (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gpointer         region_id,
                                             GtkStateType     state,
                                             gboolean         state_value);
998
GDK_DEPRECATED_IN_3_6
999 1000
void  gtk_style_context_cancel_animations   (GtkStyleContext *context,
                                             gpointer         region_id);
1001
GDK_DEPRECATED_IN_3_6
1002 1003 1004 1005
void  gtk_style_context_scroll_animations   (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gint             dx,
                                             gint             dy);
1006

1007
GDK_DEPRECATED_IN_3_6
1008 1009
void gtk_style_context_push_animatable_region (GtkStyleContext *context,
                                               gpointer         region_id);
1010
GDK_DEPRECATED_IN_3_6
1011 1012
void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);

1013
/* Some helper functions to retrieve most common properties */
1014
GDK_AVAILABLE_IN_ALL
1015 1016 1017
void gtk_style_context_get_color            (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1018
GDK_AVAILABLE_IN_ALL
1019 1020 1021
void gtk_style_context_get_background_color (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1022
GDK_AVAILABLE_IN_ALL
1023 1024 1025
void gtk_style_context_get_border_color     (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1026 1027

GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get)
1028 1029 1030
const PangoFontDescription *
     gtk_style_context_get_font             (GtkStyleContext *context,
                                             GtkStateFlags    state);
1031
GDK_AVAILABLE_IN_ALL
1032 1033 1034
void gtk_style_context_get_border           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *border);
1035
GDK_AVAILABLE_IN_ALL
1036 1037 1038
void gtk_style_context_get_padding          (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *padding);
1039
GDK_AVAILABLE_IN_ALL
1040 1041 1042
void gtk_style_context_get_margin           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *margin);
1043

1044
GDK_DEPRECATED_IN_3_12
1045
void gtk_style_context_invalidate           (GtkStyleContext *context);
1046
GDK_AVAILABLE_IN_ALL
1047
void gtk_style_context_reset_widgets        (GdkScreen       *screen);
1048

1049
GDK_AVAILABLE_IN_ALL
1050 1051
void gtk_style_context_set_background       (GtkStyleContext *context,
                                             GdkWindow       *window);
1052

1053
/* Paint methods */
1054
GDK_AVAILABLE_IN_ALL
1055 1056 1057 1058 1059 1060
void        gtk_render_check       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1061
GDK_AVAILABLE_IN_ALL
1062 1063 1064 1065 1066 1067
void        gtk_render_option      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1068
GDK_AVAILABLE_IN_ALL
1069 1070 1071 1072 1073 1074
void        gtk_render_arrow       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              angle,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              size);
1075
GDK_AVAILABLE_IN_ALL
1076 1077 1078 1079 1080 1081
void        gtk_render_background  (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1082
GDK_AVAILABLE_IN_ALL
1083 1084 1085 1086 1087 1088
void        gtk_render_frame       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1089
GDK_AVAILABLE_IN_ALL
1090 1091 1092 1093 1094 1095
void        gtk_render_expander    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1096
GDK_AVAILABLE_IN_ALL
1097 1098 1099 1100 1101 1102
void        gtk_render_focus       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1103
GDK_AVAILABLE_IN_ALL
1104 1105 1106 1107 1108
void        gtk_render_layout      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout);
1109
GDK_AVAILABLE_IN_ALL
1110 1111 1112 1113 1114 1115
void        gtk_render_line        (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x0,
                                    gdouble              y0,
                                    gdouble              x1,
                                    gdouble              y1);
1116
GDK_AVAILABLE_IN_ALL
1117 1118 1119 1120 1121 1122 1123
void        gtk_render_slider      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkOrientation       orientation);
1124
GDK_AVAILABLE_IN_ALL
1125 1126 1127 1128 1129 1130 1131 1132 1133
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);
1134
GDK_AVAILABLE_IN_ALL
1135 1136 1137 1138 1139 1140 1141
void        gtk_render_extension   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkPositionType      gap_side);
1142
GDK_AVAILABLE_IN_ALL
1143 1144 1145 1146 1147 1148
void        gtk_render_handle      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1149
GDK_AVAILABLE_IN_ALL
1150 1151 1152 1153 1154 1155
void        gtk_render_activity    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1156
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_load_icon)
1157 1158 1159
GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext     *context,
                                    const GtkIconSource *source,
                                    GtkIconSize          size);
1160
GDK_AVAILABLE_IN_3_2
1161 1162
void        gtk_render_icon        (GtkStyleContext     *context,
                                    cairo_t             *cr,
1163
                                    GdkPixbuf           *pixbuf,
1164 1165
                                    gdouble              x,
                                    gdouble              y);
1166 1167 1168 1169 1170 1171
GDK_AVAILABLE_IN_3_10
void        gtk_render_icon_surface (GtkStyleContext    *context,
				     cairo_t            *cr,
				     cairo_surface_t    *surface,
				     gdouble             x,
				     gdouble             y);
1172
GDK_AVAILABLE_IN_3_4
1173 1174 1175 1176 1177 1178 1179 1180
void        gtk_render_insertion_cursor
                                   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout,
                                    int                  index,
                                    PangoDirection       direction);
1181
GDK_DEPRECATED_IN_3_4
1182 1183 1184 1185 1186 1187 1188
void   gtk_draw_insertion_cursor    (GtkWidget          *widget,
                                     cairo_t            *cr,
                                     const GdkRectangle *location,
                                     gboolean            is_primary,
                                     GtkTextDirection    direction,
                                     gboolean            draw_arrow);

1189 1190 1191 1192 1193
/* Accessibility support */
AtkAttributeSet *_gtk_style_context_get_attributes (AtkAttributeSet *attributes,
                                                    GtkStyleContext *context,
                                                    GtkStateFlags    flags);

Carlos Garnacho's avatar
Carlos Garnacho committed
1194 1195 1196
G_END_DECLS

#endif /* __GTK_STYLE_CONTEXT_H__ */