gtkstylecontext.h 36.5 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
 */
#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:
 *
261
 * A CSS class to match menus.
262 263
 *
 * This is used in #GtkMenu.
264 265 266
 */
#define GTK_STYLE_CLASS_MENU "menu"

267 268 269 270 271 272 273 274 275 276 277
/**
 * 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"

278 279 280 281
/**
 * GTK_STYLE_CLASS_MENUBAR:
 *
 * A CSS class to menubars.
282 283
 *
 * This is used in #GtkMenuBar.
284 285 286 287 288 289 290
 */
#define GTK_STYLE_CLASS_MENUBAR "menubar"

/**
 * GTK_STYLE_CLASS_MENUITEM:
 *
 * A CSS class to match menu items.
291 292
 *
 * This is used in #GtkMenuItem and its subclasses.
293 294 295
 */
#define GTK_STYLE_CLASS_MENUITEM "menuitem"

296 297 298 299
/**
 * GTK_STYLE_CLASS_TOOLBAR:
 *
 * A CSS class to match toolbars.
300 301
 *
 * This is used in #GtkToolbar.
302 303 304
 */
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"

305 306 307 308
/**
 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
 *
 * A CSS class to match primary toolbars.
309 310 311
 *
 * This should be used for the 'main' toolbar of an application,
 * right below its menubar.
312 313 314
 */
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"

315 316 317 318
/**
 * GTK_STYLE_CLASS_INLINE_TOOLBAR:
 *
 * A CSS class to match inline toolbars.
319 320 321 322
 *
 * 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.
323 324 325
 */
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"

326 327 328 329
/**
 * GTK_STYLE_CLASS_RADIO:
 *
 * A CSS class to match radio buttons.
330 331 332
 *
 * This is used in #GtkRadioButton, #GtkRadioMenuItem and
 * #GtkCellRendererToggle.
333 334 335 336 337 338 339
 */
#define GTK_STYLE_CLASS_RADIO "radio"

/**
 * GTK_STYLE_CLASS_CHECK:
 *
 * A CSS class to match check boxes.
340 341 342
 *
 * This is used in #GtkCheckButton, #GtkCheckMenuItem and
 * #GtkCellRendererToggle.
343 344 345 346 347 348 349
 */
#define GTK_STYLE_CLASS_CHECK "check"

/**
 * GTK_STYLE_CLASS_DEFAULT:
 *
 * A CSS class to match the default widget.
350 351
 *
 * This is used by #GtkButton.
352 353 354 355 356 357 358
 */
#define GTK_STYLE_CLASS_DEFAULT "default"

/**
 * GTK_STYLE_CLASS_TROUGH:
 *
 * A CSS class to match troughs, as in scrollbars and progressbars.
359 360 361
 *
 * This is used in #GtkRange and its subclasses, #GtkProgressBar
 * and #GtkSwitch.
362 363 364 365 366 367 368 369 370 371
 */
#define GTK_STYLE_CLASS_TROUGH "trough"

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

372 373 374 375 376 377 378 379 380 381
/**
 * 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"

382 383 384 385
/**
 * GTK_STYLE_CLASS_SCALE:
 *
 * A CSS class to match scale widgets.
386 387
 *
 * This is used in #GtkScale.
388 389 390
 */
#define GTK_STYLE_CLASS_SCALE "scale"

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
/**
 * 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"

409 410 411 412
/**
 * GTK_STYLE_CLASS_HEADER:
 *
 * A CSS class to match a header element.
413 414
 *
 * This is used for the header in #GtkCalendar.
415 416 417
 */
#define GTK_STYLE_CLASS_HEADER "header"

418 419 420 421
/**
 * GTK_STYLE_CLASS_ACCELERATOR:
 *
 * A CSS class to match an accelerator.
422 423
 *
 * This is used for the accelerator in #GtkAccelLabel.
424 425 426
 */
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"

427 428 429 430 431
/**
 * GTK_STYLE_CLASS_RAISED:
 *
 * A CSS class to match a raised control, such as a raised
 * button on a toolbar.
432 433
 *
 * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
434 435 436
 */
#define GTK_STYLE_CLASS_RAISED "raised"

437 438 439 440 441 442 443 444
/**
 * 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"

445 446 447
/**
 * GTK_STYLE_CLASS_GRIP:
 *
448 449 450
 * A CSS class defining a resize grip.
 *
 * This is used for the resize grip in #GtkWindow.
451 452 453
 */
#define GTK_STYLE_CLASS_GRIP "grip"

454 455 456
/**
 * GTK_STYLE_CLASS_DOCK:
 *
457 458 459
 * A CSS class defining a dock area.
 *
 * This is used by #GtkHandleBox.
460 461 462
 */
#define GTK_STYLE_CLASS_DOCK "dock"

463 464 465
/**
 * GTK_STYLE_CLASS_PROGRESSBAR:
 *
466 467 468 469
 * 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.
470 471
 */
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
472

473 474 475
/**
 * GTK_STYLE_CLASS_SPINNER:
 *
476 477 478
 * A CSS class to use when rendering activity as a 'spinner'.
 *
 * This is used by #GtkSpinner and #GtkCellRendererSpinner.
479 480 481
 */
#define GTK_STYLE_CLASS_SPINNER "spinner"

482 483 484
/**
 * GTK_STYLE_CLASS_MARK:
 *
485 486 487
 * A CSS class defining marks in a widget, such as in scales.
 *
 * Used in #GtkScale.
488 489 490
 */
#define GTK_STYLE_CLASS_MARK "mark"

491 492 493
/**
 * GTK_STYLE_CLASS_EXPANDER:
 *
494 495 496 497
 * A CSS class defining an expander, such as those in treeviews.
 *
 * Used for drawing expanders in #GtkTreeView, GtkExpander and
 * #GtkToolItemGroup.
498 499 500
 */
#define GTK_STYLE_CLASS_EXPANDER "expander"

501 502 503
/**
 * GTK_STYLE_CLASS_SPINBUTTON:
 *
504 505 506
 * A CSS class defining an spinbutton.
 *
 * This is used in #GtkSpinButton.
507 508 509
 */
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"

510 511 512
/**
 * GTK_STYLE_CLASS_NOTEBOOK:
 *
513 514 515
 * A CSS class defining a notebook.
 *
 * Used in #GtkNotebook.
516 517 518
 */
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"

519 520 521
/**
 * GTK_STYLE_CLASS_VIEW:
 *
522 523 524 525
 * A CSS class defining a view, such as iconviews or treeviews.
 *
 * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
 * as well as #GtkCalendar.
526 527 528
 */
#define GTK_STYLE_CLASS_VIEW "view"

529 530 531
/**
 * GTK_STYLE_CLASS_SIDEBAR:
 *
532 533 534 535
 * A CSS class defining a sidebar, such as the left side in
 * a file chooser.
 *
 * This is used in #GtkFileChooser and in #GtkAssistant.
536 537 538
 */
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"

539 540 541
/**
 * GTK_STYLE_CLASS_IMAGE:
 *
542 543 544
 * A CSS class defining an image, such as the icon in an entry.
 *
 * This is used when rendering icons in #GtkEntry.
545 546 547
 */
#define GTK_STYLE_CLASS_IMAGE "image"

548 549 550 551
/**
 * GTK_STYLE_CLASS_HIGHLIGHT:
 *
 * A CSS class defining a highlighted area, such as headings in
552 553 554
 * assistants and calendars.
 *
 * This is used in #GtkAssistant and #GtkCalendar.
555 556 557
 */
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"

558 559 560
/**
 * GTK_STYLE_CLASS_FRAME:
 *
561 562 563 564 565
 * 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.
566 567 568
 */
#define GTK_STYLE_CLASS_FRAME "frame"

569 570 571
/**
 * GTK_STYLE_CLASS_DND:
 *
572 573 574 575
 * A CSS class for a drag-and-drop indicator.
 *
 * This is used when drawing an outline around a potential
 * drop target during DND.
576 577 578
 */
#define GTK_STYLE_CLASS_DND "dnd"

579 580 581 582
/**
 * GTK_STYLE_CLASS_PANE_SEPARATOR:
 *
 * A CSS class for a pane separator, such as those in #GtkPaned.
583 584
 *
 * Used in #GtkPaned.
585 586 587
 */
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"

588 589 590 591
/**
 * GTK_STYLE_CLASS_SEPARATOR:
 *
 * A CSS class for a separator.
592 593 594
 *
 * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
 * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
595 596 597
 */
#define GTK_STYLE_CLASS_SEPARATOR "separator"

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

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

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

/**
 * GTK_STYLE_CLASS_ERROR:
 *
631 632 633 634
 * A CSS class for an area displaying an error message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
635 636 637
 */
#define GTK_STYLE_CLASS_ERROR "error"

638 639 640
/**
 * GTK_STYLE_CLASS_HORIZONTAL:
 *
641 642 643
 * A CSS class for horizontally layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
644 645 646 647 648 649
 */
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"

/**
 * GTK_STYLE_CLASS_VERTICAL:
 *
650 651 652
 * A CSS class for vertically layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
653 654 655
 */
#define GTK_STYLE_CLASS_VERTICAL "vertical"

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 684 685 686 687 688 689 690 691 692 693 694
/**
 * 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"
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
/**
 * 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"

715 716 717 718 719 720 721 722
/**
 * 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"

723 724 725 726 727 728 729 730 731 732
/**
 * 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
733 734 735 736 737 738 739 740
/**
 * 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"

741 742 743 744 745 746 747 748
/**
 * 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"

749 750 751 752 753 754 755
/**
 * GTK_STYLE_CLASS_TITLEBAR:
 *
 * A CSS class used when rendering a titlebar in a toplevel
 * window.
 */
#define GTK_STYLE_CLASS_TITLEBAR "titlebar"
756

757 758 759 760 761 762 763 764 765 766 767
/**
 * 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"

768 769 770 771 772 773 774 775 776 777
/**
 * 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"

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
/* 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"

808
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
809 810
GType gtk_style_context_get_type (void) G_GNUC_CONST;

811
GDK_AVAILABLE_IN_ALL
812 813
GtkStyleContext * gtk_style_context_new (void);

814
GDK_AVAILABLE_IN_ALL
815 816 817
void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
                                                   GtkStyleProvider *provider,
                                                   guint             priority);
818
GDK_AVAILABLE_IN_ALL
819 820 821
void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
                                                   GtkStyleProvider *provider);

822
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
823 824 825 826
void gtk_style_context_add_provider    (GtkStyleContext  *context,
                                        GtkStyleProvider *provider,
                                        guint             priority);

827
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
828 829 830
void gtk_style_context_remove_provider (GtkStyleContext  *context,
                                        GtkStyleProvider *provider);

831
GDK_AVAILABLE_IN_ALL
832
void gtk_style_context_save    (GtkStyleContext *context);
833
GDK_AVAILABLE_IN_ALL
834 835
void gtk_style_context_restore (GtkStyleContext *context);

836
GDK_AVAILABLE_IN_ALL
837 838
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context,
                                               const gchar     *property);
839
GDK_AVAILABLE_IN_ALL
840 841
void gtk_style_context_get_property (GtkStyleContext *context,
                                     const gchar     *property,
842
                                     GtkStateFlags    state,
843
                                     GValue          *value);
844
GDK_AVAILABLE_IN_ALL
845
void gtk_style_context_get_valist   (GtkStyleContext *context,
846
                                     GtkStateFlags    state,
847
                                     va_list          args);
848
GDK_AVAILABLE_IN_ALL
849
void gtk_style_context_get          (GtkStyleContext *context,
850
                                     GtkStateFlags    state,
851 852
                                     ...) G_GNUC_NULL_TERMINATED;

853
GDK_AVAILABLE_IN_ALL
854 855
void          gtk_style_context_set_state    (GtkStyleContext *context,
                                              GtkStateFlags    flags);
856
GDK_AVAILABLE_IN_ALL
857 858
GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);

859 860 861 862 863 864
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);

865
GDK_DEPRECATED_IN_3_6
866 867 868
gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
                                                  GtkStateType     state,
                                                  gdouble         *progress);
869

870
GDK_AVAILABLE_IN_ALL
871 872
void          gtk_style_context_set_path     (GtkStyleContext *context,
                                              GtkWidgetPath   *path);
873
GDK_AVAILABLE_IN_ALL
874
const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
875
GDK_AVAILABLE_IN_3_4
876 877
void          gtk_style_context_set_parent   (GtkStyleContext *context,
                                              GtkStyleContext *parent);
878
GDK_AVAILABLE_IN_ALL
879 880
GtkStyleContext *gtk_style_context_get_parent (GtkStyleContext *context);

881
GDK_AVAILABLE_IN_ALL
882 883
GList *  gtk_style_context_list_classes (GtkStyleContext *context);

884
GDK_AVAILABLE_IN_ALL
885 886
void     gtk_style_context_add_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
887
GDK_AVAILABLE_IN_ALL
888 889
void     gtk_style_context_remove_class (GtkStyleContext *context,
                                         const gchar     *class_name);
890
GDK_AVAILABLE_IN_ALL
891 892
gboolean gtk_style_context_has_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
893

894
GDK_AVAILABLE_IN_ALL
895 896
GList *  gtk_style_context_list_regions (GtkStyleContext *context);

897
GDK_AVAILABLE_IN_ALL
898 899 900
void     gtk_style_context_add_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags      flags);
901
GDK_AVAILABLE_IN_ALL
902 903
void     gtk_style_context_remove_region (GtkStyleContext    *context,
                                          const gchar        *region_name);
904
GDK_AVAILABLE_IN_ALL
905 906 907
gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags     *flags_return);
908

909
GDK_AVAILABLE_IN_ALL
910 911 912
void gtk_style_context_get_style_property (GtkStyleContext *context,
                                           const gchar     *property_name,
                                           GValue          *value);
913
GDK_AVAILABLE_IN_ALL
914 915
void gtk_style_context_get_style_valist   (GtkStyleContext *context,
                                           va_list          args);
916
GDK_AVAILABLE_IN_ALL
917 918
void gtk_style_context_get_style          (GtkStyleContext *context,
                                           ...);
919

920
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_lookup_icon)
921
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
922
                                                const gchar     *stock_id);
923
GDK_DEPRECATED_IN_3_10
924 925 926
GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
                                                GtkStyleContext *context,
                                                GtkIconSize      size);
927
GDK_DEPRECATED_IN_3_10
928 929 930 931 932 933
cairo_surface_t  *
gtk_icon_set_render_icon_surface               (GtkIconSet      *icon_set,
						GtkStyleContext *context,
						GtkIconSize      size,
						int              scale,
						GdkWindow       *for_window);
934

935
GDK_AVAILABLE_IN_ALL
936 937
void        gtk_style_context_set_screen (GtkStyleContext *context,
                                          GdkScreen       *screen);
938
GDK_AVAILABLE_IN_ALL
939 940
GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);

941 942 943 944 945 946
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);

947 948 949 950 951 952
/**
 * GTK_STYLE_CLASS_READ_ONLY:
 *
 * A CSS class used to indicate a read-only state.
 */
#define GTK_STYLE_CLASS_READ_ONLY "read-only"
953

954
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_set_state)
955 956
void             gtk_style_context_set_direction (GtkStyleContext  *context,
                                                  GtkTextDirection  direction);
957
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get_state)
958 959
GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);

960
GDK_AVAILABLE_IN_ALL
961
void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
962
                                                       GtkJunctionSides  sides);
963
GDK_AVAILABLE_IN_ALL
964 965
GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);

966
GDK_AVAILABLE_IN_ALL
967 968 969
gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
                                         const gchar     *color_name,
                                         GdkRGBA         *color);
970

971
GDK_DEPRECATED_IN_3_6
972 973 974 975 976
void  gtk_style_context_notify_state_change (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gpointer         region_id,
                                             GtkStateType     state,
                                             gboolean         state_value);
977
GDK_DEPRECATED_IN_3_6
978 979
void  gtk_style_context_cancel_animations   (GtkStyleContext *context,
                                             gpointer         region_id);
980
GDK_DEPRECATED_IN_3_6
981 982 983 984
void  gtk_style_context_scroll_animations   (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gint             dx,
                                             gint             dy);
985

986
GDK_DEPRECATED_IN_3_6
987 988
void gtk_style_context_push_animatable_region (GtkStyleContext *context,
                                               gpointer         region_id);
989
GDK_DEPRECATED_IN_3_6
990 991
void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);

992
/* Some helper functions to retrieve most common properties */
993
GDK_AVAILABLE_IN_ALL
994 995 996
void gtk_style_context_get_color            (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
997
GDK_AVAILABLE_IN_ALL
998 999 1000
void gtk_style_context_get_background_color (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1001
GDK_AVAILABLE_IN_ALL
1002 1003 1004
void gtk_style_context_get_border_color     (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1005 1006

GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get)
1007 1008 1009
const PangoFontDescription *
     gtk_style_context_get_font             (GtkStyleContext *context,
                                             GtkStateFlags    state);
1010
GDK_AVAILABLE_IN_ALL
1011 1012 1013
void gtk_style_context_get_border           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *border);
1014
GDK_AVAILABLE_IN_ALL
1015 1016 1017
void gtk_style_context_get_padding          (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *padding);
1018
GDK_AVAILABLE_IN_ALL
1019 1020 1021
void gtk_style_context_get_margin           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *margin);
1022

1023
GDK_DEPRECATED_IN_3_12
1024
void gtk_style_context_invalidate           (GtkStyleContext *context);
1025
GDK_AVAILABLE_IN_ALL
1026
void gtk_style_context_reset_widgets        (GdkScreen       *screen);
1027

1028
GDK_AVAILABLE_IN_ALL
1029 1030
void gtk_style_context_set_background       (GtkStyleContext *context,
                                             GdkWindow       *window);
1031

1032
/* Paint methods */
1033
GDK_AVAILABLE_IN_ALL
1034 1035 1036 1037 1038 1039
void        gtk_render_check       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1040
GDK_AVAILABLE_IN_ALL
1041 1042 1043 1044 1045 1046
void        gtk_render_option      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1047
GDK_AVAILABLE_IN_ALL
1048 1049 1050 1051 1052 1053
void        gtk_render_arrow       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              angle,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              size);
1054
GDK_AVAILABLE_IN_ALL
1055 1056 1057 1058 1059 1060
void        gtk_render_background  (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_frame       (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_expander    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1075
GDK_AVAILABLE_IN_ALL
1076 1077 1078 1079 1080 1081
void        gtk_render_focus       (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1082
GDK_AVAILABLE_IN_ALL
1083 1084 1085 1086 1087
void        gtk_render_layout      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout);
1088
GDK_AVAILABLE_IN_ALL
1089 1090 1091 1092 1093 1094
void        gtk_render_line        (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x0,
                                    gdouble              y0,
                                    gdouble              x1,
                                    gdouble              y1);
1095
GDK_AVAILABLE_IN_ALL
1096 1097 1098 1099 1100 1101 1102
void        gtk_render_slider      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkOrientation       orientation);
1103
GDK_AVAILABLE_IN_ALL
1104 1105 1106 1107 1108 1109 1110 1111 1112
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);
1113
GDK_AVAILABLE_IN_ALL
1114 1115 1116 1117 1118 1119 1120
void        gtk_render_extension   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height,
                                    GtkPositionType      gap_side);
1121
GDK_AVAILABLE_IN_ALL
1122 1123 1124 1125 1126 1127
void        gtk_render_handle      (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1128
GDK_AVAILABLE_IN_ALL
1129 1130 1131 1132 1133 1134
void        gtk_render_activity    (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    gdouble              width,
                                    gdouble              height);
1135
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_load_icon)
1136 1137 1138
GdkPixbuf * gtk_render_icon_pixbuf (GtkStyleContext     *context,
                                    const GtkIconSource *source,
                                    GtkIconSize          size);
1139
GDK_AVAILABLE_IN_3_2
1140 1141
void        gtk_render_icon        (GtkStyleContext     *context,
                                    cairo_t             *cr,
1142
                                    GdkPixbuf           *pixbuf,
1143 1144
                                    gdouble              x,
                                    gdouble              y);
1145 1146 1147 1148 1149 1150
GDK_AVAILABLE_IN_3_10
void        gtk_render_icon_surface (GtkStyleContext    *context,
				     cairo_t            *cr,
				     cairo_surface_t    *surface,
				     gdouble             x,
				     gdouble             y);
1151
GDK_AVAILABLE_IN_3_4
1152 1153 1154 1155 1156 1157 1158 1159
void        gtk_render_insertion_cursor
                                   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout,
                                    int                  index,
                                    PangoDirection       direction);
1160
GDK_DEPRECATED_IN_3_4
1161 1162 1163 1164 1165 1166 1167
void   gtk_draw_insertion_cursor    (GtkWidget          *widget,
                                     cairo_t            *cr,
                                     const GdkRectangle *location,
                                     gboolean            is_primary,
                                     GtkTextDirection    direction,
                                     gboolean            draw_arrow);

1168 1169 1170 1171 1172
/* Accessibility support */
AtkAttributeSet *_gtk_style_context_get_attributes (AtkAttributeSet *attributes,
                                                    GtkStyleContext *context,
                                                    GtkStateFlags    flags);

Carlos Garnacho's avatar
Carlos Garnacho committed
1173 1174 1175
G_END_DECLS

#endif /* __GTK_STYLE_CONTEXT_H__ */