gtkstylecontext.h 32.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 188 189
/**
 * GTK_STYLE_CLASS_LABEL:
 *
 * A CSS class to match labels.
 *
 * This is used by #GtkLabel.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_LABEL "label"

190 191 192 193 194 195 196 197 198
/**
 * 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"

199 200 201 202
/**
 * GTK_STYLE_CLASS_BUTTON:
 *
 * A CSS class to match buttons.
203 204 205 206
 *
 * 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.
207 208 209
 */
#define GTK_STYLE_CLASS_BUTTON "button"

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
/**
 * 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"

228 229 230 231
/**
 * GTK_STYLE_CLASS_CALENDAR:
 *
 * A CSS class to match calendars.
232 233
 *
 * This is not used by GTK+ itself, currently.
234 235 236 237 238 239 240
 */
#define GTK_STYLE_CLASS_CALENDAR "calendar"

/**
 * GTK_STYLE_CLASS_SLIDER:
 *
 * A CSS class to match sliders.
241 242
 *
 * This is used by #GtkSwitch and #GtkRange and its subclasses.
243 244 245 246 247 248 249 250 251 252 253 254 255 256
 */
#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.
257 258
 *
 * This is used in #GtkIconView and #GtkTreeView.
259 260 261
 */
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"

Matthias Clasen's avatar
Matthias Clasen committed
262 263 264 265 266 267 268 269 270 271
/**
 * 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"

272 273 274 275 276 277 278 279 280 281
/**
 * GTK_STYLE_CLASS_TOOLTIP:
 *
 * A CSS class to match tooltip windows.
 */
#define GTK_STYLE_CLASS_TOOLTIP "tooltip"

/**
 * GTK_STYLE_CLASS_MENU:
 *
282
 * A CSS class to match menus.
283 284
 *
 * This is used in #GtkMenu.
285 286 287
 */
#define GTK_STYLE_CLASS_MENU "menu"

288 289 290 291 292 293 294 295 296 297 298
/**
 * 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"

299 300 301 302 303 304 305 306 307 308
/**
 * GTK_STYLE_CLASS_TOUCH_SELECTION:
 *
 * A CSS class for touch selection popups on entries
 * and text views.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_TOUCH_SELECTION "touch-selection"

309 310 311 312
/**
 * GTK_STYLE_CLASS_MENUBAR:
 *
 * A CSS class to menubars.
313 314
 *
 * This is used in #GtkMenuBar.
315 316 317 318 319 320 321
 */
#define GTK_STYLE_CLASS_MENUBAR "menubar"

/**
 * GTK_STYLE_CLASS_MENUITEM:
 *
 * A CSS class to match menu items.
322 323
 *
 * This is used in #GtkMenuItem and its subclasses.
324 325 326
 */
#define GTK_STYLE_CLASS_MENUITEM "menuitem"

327 328 329 330
/**
 * GTK_STYLE_CLASS_TOOLBAR:
 *
 * A CSS class to match toolbars.
331 332
 *
 * This is used in #GtkToolbar.
333 334 335
 */
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"

336 337 338 339
/**
 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
 *
 * A CSS class to match primary toolbars.
340
 *
341
 * This should be used for the “main” toolbar of an application,
342
 * right below its menubar.
343 344 345
 */
#define GTK_STYLE_CLASS_PRIMARY_TOOLBAR "primary-toolbar"

346 347 348 349
/**
 * GTK_STYLE_CLASS_INLINE_TOOLBAR:
 *
 * A CSS class to match inline toolbars.
350 351 352 353
 *
 * 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.
354 355 356
 */
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"

357 358 359 360 361 362 363 364 365 366 367
/**
 * GTK_STYLE_CLASS_STATUSBAR:
 *
 * A CSS class to match statusbars.
 *
 * This is used in #GtkStatusbar.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_STATUSBAR "statusbar"

368 369 370 371
/**
 * GTK_STYLE_CLASS_RADIO:
 *
 * A CSS class to match radio buttons.
372 373 374
 *
 * This is used in #GtkRadioButton, #GtkRadioMenuItem and
 * #GtkCellRendererToggle.
375 376 377 378 379 380 381
 */
#define GTK_STYLE_CLASS_RADIO "radio"

/**
 * GTK_STYLE_CLASS_CHECK:
 *
 * A CSS class to match check boxes.
382 383 384
 *
 * This is used in #GtkCheckButton, #GtkCheckMenuItem and
 * #GtkCellRendererToggle.
385 386 387 388 389 390 391
 */
#define GTK_STYLE_CLASS_CHECK "check"

/**
 * GTK_STYLE_CLASS_DEFAULT:
 *
 * A CSS class to match the default widget.
392 393
 *
 * This is used by #GtkButton.
394 395 396 397 398 399 400
 */
#define GTK_STYLE_CLASS_DEFAULT "default"

/**
 * GTK_STYLE_CLASS_TROUGH:
 *
 * A CSS class to match troughs, as in scrollbars and progressbars.
401 402 403
 *
 * This is used in #GtkRange and its subclasses, #GtkProgressBar
 * and #GtkSwitch.
404 405 406 407 408 409 410 411 412 413
 */
#define GTK_STYLE_CLASS_TROUGH "trough"

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

414 415 416 417
/**
 * GTK_STYLE_CLASS_SCROLLBARS_JUNCTION:
 *
 * A CSS class to match the junction area between an horizontal
418
 * and vertical scrollbar, when they’re both shown.
419 420 421 422 423
 * 
 * This is used in #GtkScrolledWindow.
 */
#define GTK_STYLE_CLASS_SCROLLBARS_JUNCTION "scrollbars-junction"

424 425 426 427
/**
 * GTK_STYLE_CLASS_SCALE:
 *
 * A CSS class to match scale widgets.
428 429
 *
 * This is used in #GtkScale.
430 431 432
 */
#define GTK_STYLE_CLASS_SCALE "scale"

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
/**
 * 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"

451 452 453 454
/**
 * GTK_STYLE_CLASS_HEADER:
 *
 * A CSS class to match a header element.
455 456
 *
 * This is used for the header in #GtkCalendar.
457 458 459
 */
#define GTK_STYLE_CLASS_HEADER "header"

460 461 462 463
/**
 * GTK_STYLE_CLASS_ACCELERATOR:
 *
 * A CSS class to match an accelerator.
464 465
 *
 * This is used for the accelerator in #GtkAccelLabel.
466 467 468
 */
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"

469 470 471 472 473
/**
 * GTK_STYLE_CLASS_RAISED:
 *
 * A CSS class to match a raised control, such as a raised
 * button on a toolbar.
474 475
 *
 * This should be used in conjunction with #GTK_STYLE_CLASS_PRIMARY_TOOLBAR.
476 477 478
 */
#define GTK_STYLE_CLASS_RAISED "raised"

479 480 481 482 483 484 485 486
/**
 * 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"

487 488 489
/**
 * GTK_STYLE_CLASS_GRIP:
 *
490 491 492
 * A CSS class defining a resize grip.
 *
 * This is used for the resize grip in #GtkWindow.
493 494 495
 */
#define GTK_STYLE_CLASS_GRIP "grip"

496 497 498
/**
 * GTK_STYLE_CLASS_DOCK:
 *
499 500 501
 * A CSS class defining a dock area.
 *
 * This is used by #GtkHandleBox.
502 503 504
 */
#define GTK_STYLE_CLASS_DOCK "dock"

505 506 507
/**
 * GTK_STYLE_CLASS_PROGRESSBAR:
 *
508 509 510 511
 * 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.
512 513
 */
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
514

515 516 517
/**
 * GTK_STYLE_CLASS_SPINNER:
 *
518
 * A CSS class to use when rendering activity as a “spinner”.
519 520
 *
 * This is used by #GtkSpinner and #GtkCellRendererSpinner.
521 522 523
 */
#define GTK_STYLE_CLASS_SPINNER "spinner"

524 525 526
/**
 * GTK_STYLE_CLASS_MARK:
 *
527 528 529
 * A CSS class defining marks in a widget, such as in scales.
 *
 * Used in #GtkScale.
530 531 532
 */
#define GTK_STYLE_CLASS_MARK "mark"

533 534 535
/**
 * GTK_STYLE_CLASS_EXPANDER:
 *
536 537 538 539
 * A CSS class defining an expander, such as those in treeviews.
 *
 * Used for drawing expanders in #GtkTreeView, GtkExpander and
 * #GtkToolItemGroup.
540 541 542
 */
#define GTK_STYLE_CLASS_EXPANDER "expander"

543 544 545
/**
 * GTK_STYLE_CLASS_SPINBUTTON:
 *
546 547 548
 * A CSS class defining an spinbutton.
 *
 * This is used in #GtkSpinButton.
549 550 551
 */
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"

552 553 554
/**
 * GTK_STYLE_CLASS_NOTEBOOK:
 *
555 556 557
 * A CSS class defining a notebook.
 *
 * Used in #GtkNotebook.
558 559 560
 */
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"

561 562 563
/**
 * GTK_STYLE_CLASS_VIEW:
 *
564 565 566 567
 * A CSS class defining a view, such as iconviews or treeviews.
 *
 * This is used in #GtkTreeView, #GtkIconView, #GtkTextView,
 * as well as #GtkCalendar.
568 569 570
 */
#define GTK_STYLE_CLASS_VIEW "view"

571 572 573
/**
 * GTK_STYLE_CLASS_SIDEBAR:
 *
574 575 576 577
 * A CSS class defining a sidebar, such as the left side in
 * a file chooser.
 *
 * This is used in #GtkFileChooser and in #GtkAssistant.
578 579 580
 */
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"

581 582 583
/**
 * GTK_STYLE_CLASS_IMAGE:
 *
584 585 586
 * A CSS class defining an image, such as the icon in an entry.
 *
 * This is used when rendering icons in #GtkEntry.
587 588 589
 */
#define GTK_STYLE_CLASS_IMAGE "image"

590 591 592 593
/**
 * GTK_STYLE_CLASS_HIGHLIGHT:
 *
 * A CSS class defining a highlighted area, such as headings in
594 595 596
 * assistants and calendars.
 *
 * This is used in #GtkAssistant and #GtkCalendar.
597 598 599
 */
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"

600 601 602
/**
 * GTK_STYLE_CLASS_FRAME:
 *
603 604 605 606 607
 * 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.
608 609 610
 */
#define GTK_STYLE_CLASS_FRAME "frame"

611 612 613
/**
 * GTK_STYLE_CLASS_DND:
 *
614 615 616 617
 * A CSS class for a drag-and-drop indicator.
 *
 * This is used when drawing an outline around a potential
 * drop target during DND.
618 619 620
 */
#define GTK_STYLE_CLASS_DND "dnd"

621 622 623 624
/**
 * GTK_STYLE_CLASS_PANE_SEPARATOR:
 *
 * A CSS class for a pane separator, such as those in #GtkPaned.
625 626
 *
 * Used in #GtkPaned.
627 628 629
 */
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"

630 631 632 633
/**
 * GTK_STYLE_CLASS_SEPARATOR:
 *
 * A CSS class for a separator.
634 635 636
 *
 * This is used in #GtkSeparator, #GtkSeparatorMenuItem,
 * #GtkSeparatorToolItem, and when drawing separators in #GtkTreeView.
637 638 639
 */
#define GTK_STYLE_CLASS_SEPARATOR "separator"

640 641 642
/**
 * GTK_STYLE_CLASS_INFO:
 *
643 644 645 646
 * A CSS class for an area displaying an informational message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
647 648 649 650 651 652
 */
#define GTK_STYLE_CLASS_INFO "info"

/**
 * GTK_STYLE_CLASS_WARNING:
 *
653 654 655 656
 * A CSS class for an area displaying a warning message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
657 658 659 660 661 662
 */
#define GTK_STYLE_CLASS_WARNING "warning"

/**
 * GTK_STYLE_CLASS_QUESTION:
 *
663 664 665 666
 * A CSS class for an area displaying a question to the user,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
667 668 669 670 671 672
 */
#define GTK_STYLE_CLASS_QUESTION "question"

/**
 * GTK_STYLE_CLASS_ERROR:
 *
673 674 675 676
 * A CSS class for an area displaying an error message,
 * such as those in infobars.
 *
 * This is used by #GtkInfoBar.
677 678 679
 */
#define GTK_STYLE_CLASS_ERROR "error"

680 681 682
/**
 * GTK_STYLE_CLASS_HORIZONTAL:
 *
683 684 685
 * A CSS class for horizontally layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
686 687 688 689 690 691
 */
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"

/**
 * GTK_STYLE_CLASS_VERTICAL:
 *
692 693 694
 * A CSS class for vertically layered widgets.
 *
 * This is used by widgets implementing #GtkOrientable.
695 696 697
 */
#define GTK_STYLE_CLASS_VERTICAL "vertical"

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
/**
 * 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"
737

738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
/**
 * 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"

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

765 766 767 768 769 770 771 772 773 774
/**
 * 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
775 776 777 778 779 780 781 782
/**
 * 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"

783 784 785 786 787 788 789 790
/**
 * 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"

791 792 793 794 795 796 797
/**
 * GTK_STYLE_CLASS_TITLEBAR:
 *
 * A CSS class used when rendering a titlebar in a toplevel
 * window.
 */
#define GTK_STYLE_CLASS_TITLEBAR "titlebar"
798

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
/**
 * GTK_STYLE_CLASS_TITLE:
 *
 * A CSS class used for the title label in a titlebar in
 * a toplevel window.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_TITLE "title"

/**
 * GTK_STYLE_CLASS_SUBTITLE:
 *
 * A CSS class used for the subtitle label in a titlebar in
 * a toplevel window.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_SUBTITLE "subtitle"

819 820 821 822 823 824 825 826 827 828 829
/**
 * 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"

830 831 832 833 834 835 836 837 838 839
/**
 * 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"

840 841 842 843 844 845 846 847 848 849 850
/**
 * 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"

851 852 853 854 855 856 857 858 859
/**
 * GTK_STYLE_CLASS_POPOVER:
 *
 * A CSS class that matches popovers. Used by #GtkPopover.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_POPOVER "popover"

860 861
/* Predefined set of widget regions */

862 863 864 865 866 867 868 869 870
/**
 * GTK_STYLE_CLASS_POPUP:
 *
 * A CSS class that is added to the toplevel windows used for menus.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_POPUP "popup"

871 872 873 874 875 876 877 878 879
/**
 * GTK_STYLE_CLASS_MESSAGE_DIALOG:
 *
 * A CSS class that is added to message dialogs.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_MESSAGE_DIALOG "message-dialog"

Matthias Clasen's avatar
Matthias Clasen committed
880 881 882 883 884 885 886 887 888 889 890
/**
 * GTK_STYLE_CLASS_FLAT:
 *
 * A CSS class that is added when widgets that usually have
 * a frame or border (like buttons or entries) should appear
 * without it.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_FLAT "flat"

Matthias Clasen's avatar
Matthias Clasen committed
891 892 893 894 895 896 897
/**
 * GTK_STYLE_CLASS_READ_ONLY:
 *
 * A CSS class used to indicate a read-only state.
 */
#define GTK_STYLE_CLASS_READ_ONLY "read-only"

898 899 900 901 902 903 904 905 906 907
/*
 * GTK_STYLE_CLASS_OVERSHOOT:
 * A CSS class that is added on the visual hints that happen
 * when scrolling is attempted past the limits of a scrollable
 * area.
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_OVERSHOOT "overshoot"

908 909 910 911 912 913 914 915 916 917
/*
 * GTK_STYLE_CLASS_UNDERSHOOT:
 * A CSS class that is added on the visual hints that happen
 * where content is 'scrolled off' and can be made visible
 * by scrolling.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_UNDERSHOOT "undershoot"

918 919 920 921 922 923 924 925 926 927 928
/*
 * GTK_STYLE_CLASS_PAPER:
 * A CSS class that is added to areas that should look like paper.
 *
 * This is used in print previews and themes are encouraged to
 * style it as black text on white background.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_PAPER "paper"

929 930 931 932 933 934 935 936 937 938
/**
 * GTK_STYLE_CLASS_MONOSPACE:
 *
 * A CSS class that is added to text view that should use
 * a monospace font.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_MONOSPACE "monospace"

939 940 941 942 943 944 945 946 947 948
/**
 * GTK_STYLE_CLASS_WIDE:
 *
 * A CSS class to indicate that a UI element should be 'wide'.
 * Used by #GtkPaned.
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_WIDE "wide"

949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
/**
 * 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"

977
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
978 979
GType gtk_style_context_get_type (void) G_GNUC_CONST;

980
GDK_AVAILABLE_IN_ALL
981 982
GtkStyleContext * gtk_style_context_new (void);

983
GDK_AVAILABLE_IN_ALL
984 985 986
void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
                                                   GtkStyleProvider *provider,
                                                   guint             priority);
987
GDK_AVAILABLE_IN_ALL
988 989 990
void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
                                                   GtkStyleProvider *provider);

991
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
992 993 994 995
void gtk_style_context_add_provider    (GtkStyleContext  *context,
                                        GtkStyleProvider *provider,
                                        guint             priority);

996
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
997 998 999
void gtk_style_context_remove_provider (GtkStyleContext  *context,
                                        GtkStyleProvider *provider);

1000
GDK_AVAILABLE_IN_ALL
1001
void gtk_style_context_save    (GtkStyleContext *context);
1002
GDK_AVAILABLE_IN_ALL
1003 1004
void gtk_style_context_restore (GtkStyleContext *context);

1005
GDK_AVAILABLE_IN_ALL
1006 1007
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context,
                                               const gchar     *property);
1008
GDK_AVAILABLE_IN_ALL
1009 1010
void gtk_style_context_get_property (GtkStyleContext *context,
                                     const gchar     *property,
1011
                                     GtkStateFlags    state,
1012
                                     GValue          *value);
1013
GDK_AVAILABLE_IN_ALL
1014
void gtk_style_context_get_valist   (GtkStyleContext *context,
1015
                                     GtkStateFlags    state,
1016
                                     va_list          args);
1017
GDK_AVAILABLE_IN_ALL
1018
void gtk_style_context_get          (GtkStyleContext *context,
1019
                                     GtkStateFlags    state,
1020 1021
                                     ...) G_GNUC_NULL_TERMINATED;

1022
GDK_AVAILABLE_IN_ALL
1023 1024
void          gtk_style_context_set_state    (GtkStyleContext *context,
                                              GtkStateFlags    flags);
1025
GDK_AVAILABLE_IN_ALL
1026 1027
GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);

1028 1029 1030 1031 1032 1033
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);

1034
GDK_DEPRECATED_IN_3_6
1035 1036 1037
gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
                                                  GtkStateType     state,
                                                  gdouble         *progress);
1038

1039
GDK_AVAILABLE_IN_ALL
1040 1041
void          gtk_style_context_set_path     (GtkStyleContext *context,
                                              GtkWidgetPath   *path);
1042
GDK_AVAILABLE_IN_ALL
1043
const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
1044
GDK_AVAILABLE_IN_3_4
1045 1046
void          gtk_style_context_set_parent   (GtkStyleContext *context,
                                              GtkStyleContext *parent);
1047
GDK_AVAILABLE_IN_ALL
1048 1049
GtkStyleContext *gtk_style_context_get_parent (GtkStyleContext *context);

1050
GDK_AVAILABLE_IN_ALL
1051 1052
GList *  gtk_style_context_list_classes (GtkStyleContext *context);

1053
GDK_AVAILABLE_IN_ALL
1054 1055
void     gtk_style_context_add_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
1056
GDK_AVAILABLE_IN_ALL
1057 1058
void     gtk_style_context_remove_class (GtkStyleContext *context,
                                         const gchar     *class_name);
1059
GDK_AVAILABLE_IN_ALL
1060 1061
gboolean gtk_style_context_has_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
1062

1063
GDK_DEPRECATED_IN_3_14
1064 1065
GList *  gtk_style_context_list_regions (GtkStyleContext *context);

1066
GDK_DEPRECATED_IN_3_14
1067 1068 1069
void     gtk_style_context_add_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags      flags);
1070
GDK_DEPRECATED_IN_3_14
1071 1072
void     gtk_style_context_remove_region (GtkStyleContext    *context,
                                          const gchar        *region_name);
1073
GDK_DEPRECATED_IN_3_14
1074 1075 1076
gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags     *flags_return);
1077

1078
GDK_AVAILABLE_IN_ALL
1079 1080 1081
void gtk_style_context_get_style_property (GtkStyleContext *context,
                                           const gchar     *property_name,
                                           GValue          *value);
1082
GDK_AVAILABLE_IN_ALL
1083 1084
void gtk_style_context_get_style_valist   (GtkStyleContext *context,
                                           va_list          args);
1085
GDK_AVAILABLE_IN_ALL
1086 1087
void gtk_style_context_get_style          (GtkStyleContext *context,
                                           ...);
1088

1089
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_lookup_icon)
1090
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
1091
                                                const gchar     *stock_id);
1092
GDK_DEPRECATED_IN_3_10
1093 1094 1095
GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
                                                GtkStyleContext *context,
                                                GtkIconSize      size);
1096
GDK_DEPRECATED_IN_3_10
1097 1098 1099 1100 1101 1102
cairo_surface_t  *
gtk_icon_set_render_icon_surface               (GtkIconSet      *icon_set,
						GtkStyleContext *context,
						GtkIconSize      size,
						int              scale,
						GdkWindow       *for_window);
1103

1104
GDK_AVAILABLE_IN_ALL
1105 1106
void        gtk_style_context_set_screen (GtkStyleContext *context,
                                          GdkScreen       *screen);
1107
GDK_AVAILABLE_IN_ALL
1108 1109
GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);

1110 1111 1112 1113 1114 1115
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);

1116
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_set_state)
1117 1118
void             gtk_style_context_set_direction (GtkStyleContext  *context,
                                                  GtkTextDirection  direction);
1119
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get_state)
1120 1121
GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);

1122
GDK_AVAILABLE_IN_ALL
1123
void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
1124
                                                       GtkJunctionSides  sides);
1125
GDK_AVAILABLE_IN_ALL
1126 1127
GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);

1128
GDK_AVAILABLE_IN_ALL
1129 1130 1131
gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
                                         const gchar     *color_name,
                                         GdkRGBA         *color);
1132

1133
GDK_DEPRECATED_IN_3_6
1134 1135 1136 1137 1138
void  gtk_style_context_notify_state_change (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gpointer         region_id,
                                             GtkStateType     state,
                                             gboolean         state_value);
1139
GDK_DEPRECATED_IN_3_6
1140 1141
void  gtk_style_context_cancel_animations   (GtkStyleContext *context,
                                             gpointer         region_id);
1142
GDK_DEPRECATED_IN_3_6
1143 1144 1145 1146
void  gtk_style_context_scroll_animations   (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gint             dx,
                                             gint             dy);
1147

1148
GDK_DEPRECATED_IN_3_6
1149 1150
void gtk_style_context_push_animatable_region (GtkStyleContext *context,
                                               gpointer         region_id);
1151
GDK_DEPRECATED_IN_3_6
1152 1153
void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);

1154
/* Some helper functions to retrieve most common properties */
1155
GDK_AVAILABLE_IN_ALL
1156 1157 1158
void gtk_style_context_get_color            (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1159
GDK_DEPRECATED_IN_3_16_FOR(gtk_render_background)
1160 1161 1162
void gtk_style_context_get_background_color (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1163
GDK_DEPRECATED_IN_3_16_FOR(gtk_render_frame)
1164 1165 1166
void gtk_style_context_get_border_color     (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1167 1168

GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get)
1169 1170 1171
const PangoFontDescription *
     gtk_style_context_get_font             (GtkStyleContext *context,
                                             GtkStateFlags    state);
1172
GDK_AVAILABLE_IN_ALL
1173 1174 1175
void gtk_style_context_get_border           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *border);
1176
GDK_AVAILABLE_IN_ALL
1177 1178 1179
void gtk_style_context_get_padding          (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *padding);
1180
GDK_AVAILABLE_IN_ALL
1181 1182 1183
void gtk_style_context_get_margin           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *margin);
1184

1185
GDK_DEPRECATED_IN_3_12
1186
void gtk_style_context_invalidate           (GtkStyleContext *context);
1187
GDK_AVAILABLE_IN_ALL
1188
void gtk_style_context_reset_widgets        (GdkScreen       *screen);
1189

1190
GDK_DEPRECATED_IN_3_18_FOR(gtk_render_background)
1191 1192
void gtk_style_context_set_background       (GtkStyleContext *context,
                                             GdkWindow       *window);
1193

1194
GDK_AVAILABLE_IN_3_4
1195 1196 1197 1198 1199 1200 1201 1202
void        gtk_render_insertion_cursor
                                   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout,
                                    int                  index,
                                    PangoDirection       direction);
1203
GDK_DEPRECATED_IN_3_4
1204 1205 1206 1207 1208 1209 1210
void   gtk_draw_insertion_cursor    (GtkWidget          *widget,
                                     cairo_t            *cr,
                                     const GdkRectangle *location,
                                     gboolean            is_primary,
                                     GtkTextDirection    direction,
                                     gboolean            draw_arrow);

Carlos Garnacho's avatar
Carlos Garnacho committed
1211 1212 1213
G_END_DECLS

#endif /* __GTK_STYLE_CONTEXT_H__ */