gtkstylecontext.h 35.6 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
 * Refer to individual widget documentation for used style classes.
156 157 158
 */
#define GTK_STYLE_CLASS_CELL "cell"

159 160 161 162 163
/**
 * GTK_STYLE_CLASS_DIM_LABEL:
 *
 * A CSS class to match dimmed labels.
 *
164
 * Refer to individual widget documentation for used style classes.
165 166 167
 */
#define GTK_STYLE_CLASS_DIM_LABEL "dim-label"

168 169 170 171
/**
 * GTK_STYLE_CLASS_ENTRY:
 *
 * A CSS class to match text entries.
172
 *
173
 * Refer to individual widget documentation for used style classes.
174 175 176
 */
#define GTK_STYLE_CLASS_ENTRY "entry"

177 178 179 180 181
/**
 * GTK_STYLE_CLASS_LABEL:
 *
 * A CSS class to match labels.
 *
182
 * Refer to individual widget documentation for used style classes.
183 184 185 186 187
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_LABEL "label"

188 189 190 191 192
/**
 * GTK_STYLE_CLASS_COMBOBOX_ENTRY:
 *
 * A CSS class to match combobox entries.
 *
193
 * Refer to individual widget documentation for used style classes.
194 195 196
 */
#define GTK_STYLE_CLASS_COMBOBOX_ENTRY "combobox-entry"

197 198 199 200
/**
 * GTK_STYLE_CLASS_BUTTON:
 *
 * A CSS class to match buttons.
201
 *
202
 * Refer to individual widget documentation for used style classes.
203 204 205
 */
#define GTK_STYLE_CLASS_BUTTON "button"

206 207 208 209 210
/**
 * GTK_STYLE_CLASS_LIST:
 *
 * A CSS class to match lists.
 *
211
 * Refer to individual widget documentation for used style classes.
212 213 214 215 216 217
 */
#define GTK_STYLE_CLASS_LIST "list"

/**
 * GTK_STYLE_CLASS_LIST_ROW:
 *
218
 * A CSS class to match list rows.
219
 *
220
 * Refer to individual widget documentation for used style classes.
221 222 223
 */
#define GTK_STYLE_CLASS_LIST_ROW "list-row"

224 225 226 227
/**
 * GTK_STYLE_CLASS_CALENDAR:
 *
 * A CSS class to match calendars.
228
 *
229
 * Refer to individual widget documentation for used style classes.
230 231 232 233 234 235 236
 */
#define GTK_STYLE_CLASS_CALENDAR "calendar"

/**
 * GTK_STYLE_CLASS_SLIDER:
 *
 * A CSS class to match sliders.
237
 *
238
 * Refer to individual widget documentation for used style classes.
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.
246 247
 *
 * Refer to individual widget documentation for used style classes.
248 249 250 251 252 253 254
 */
#define GTK_STYLE_CLASS_BACKGROUND "background"

/**
 * GTK_STYLE_CLASS_RUBBERBAND:
 *
 * A CSS class to match the rubberband selection rectangle.
255
 *
256
 * Refer to individual widget documentation for used style classes.
257 258 259
 */
#define GTK_STYLE_CLASS_RUBBERBAND "rubberband"

Matthias Clasen's avatar
Matthias Clasen committed
260 261 262
/**
 * GTK_STYLE_CLASS_CSD:
 *
263 264 265
 * A CSS class that gets added to windows which have client-side decorations.
 *
 * Refer to individual widget documentation for used style classes.
Matthias Clasen's avatar
Matthias Clasen committed
266 267 268 269 270
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_CSD "csd"

271 272 273 274
/**
 * GTK_STYLE_CLASS_TOOLTIP:
 *
 * A CSS class to match tooltip windows.
275 276
 *
 * Refer to individual widget documentation for used style classes.
277 278 279 280 281 282
 */
#define GTK_STYLE_CLASS_TOOLTIP "tooltip"

/**
 * GTK_STYLE_CLASS_MENU:
 *
283
 * A CSS class to match menus.
284
 *
285
 * Refer to individual widget documentation for used style classes.
286 287 288
 */
#define GTK_STYLE_CLASS_MENU "menu"

289 290 291 292 293
/**
 * GTK_STYLE_CLASS_CONTEXT_MENU:
 *
 * A CSS class to match context menus.
 *
294
 * Refer to individual widget documentation for used style classes.
295 296 297
 */
#define GTK_STYLE_CLASS_CONTEXT_MENU "context-menu"

298 299 300 301 302 303
/**
 * GTK_STYLE_CLASS_TOUCH_SELECTION:
 *
 * A CSS class for touch selection popups on entries
 * and text views.
 *
304 305
 * Refer to individual widget documentation for used style classes.
 *
306 307 308 309
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_TOUCH_SELECTION "touch-selection"

310 311 312 313
/**
 * GTK_STYLE_CLASS_MENUBAR:
 *
 * A CSS class to menubars.
314
 *
315
 * Refer to individual widget documentation for used style classes.
316 317 318 319 320 321 322
 */
#define GTK_STYLE_CLASS_MENUBAR "menubar"

/**
 * GTK_STYLE_CLASS_MENUITEM:
 *
 * A CSS class to match menu items.
323
 *
324
 * Refer to individual widget documentation for used style classes.
325 326 327
 */
#define GTK_STYLE_CLASS_MENUITEM "menuitem"

328 329 330 331
/**
 * GTK_STYLE_CLASS_TOOLBAR:
 *
 * A CSS class to match toolbars.
332
 *
333
 * Refer to individual widget documentation for used style classes.
334 335 336
 */
#define GTK_STYLE_CLASS_TOOLBAR "toolbar"

337 338 339 340
/**
 * GTK_STYLE_CLASS_PRIMARY_TOOLBAR:
 *
 * A CSS class to match primary toolbars.
341
 *
342
 * Refer to individual widget documentation for used style classes.
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
 * Refer to individual widget documentation for used style classes.
352 353 354
 */
#define GTK_STYLE_CLASS_INLINE_TOOLBAR "inline-toolbar"

355 356 357 358 359
/**
 * GTK_STYLE_CLASS_STATUSBAR:
 *
 * A CSS class to match statusbars.
 *
360
 * Refer to individual widget documentation for used style classes.
361 362 363 364 365
 *
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_STATUSBAR "statusbar"

366 367 368 369
/**
 * GTK_STYLE_CLASS_RADIO:
 *
 * A CSS class to match radio buttons.
370
 *
371
 * Refer to individual widget documentation for used style classes.
372 373 374 375 376 377 378
 */
#define GTK_STYLE_CLASS_RADIO "radio"

/**
 * GTK_STYLE_CLASS_CHECK:
 *
 * A CSS class to match check boxes.
379
 *
380
 * Refer to individual widget documentation for used style classes.
381 382 383 384 385 386 387
 */
#define GTK_STYLE_CLASS_CHECK "check"

/**
 * GTK_STYLE_CLASS_DEFAULT:
 *
 * A CSS class to match the default widget.
388
 *
389
 * Refer to individual widget documentation for used style classes.
390 391 392 393 394 395 396
 */
#define GTK_STYLE_CLASS_DEFAULT "default"

/**
 * GTK_STYLE_CLASS_TROUGH:
 *
 * A CSS class to match troughs, as in scrollbars and progressbars.
397
 *
398
 * Refer to individual widget documentation for used style classes.
399 400 401 402 403 404 405
 */
#define GTK_STYLE_CLASS_TROUGH "trough"

/**
 * GTK_STYLE_CLASS_SCROLLBAR:
 *
 * A CSS class to match scrollbars.
406 407
 *
 * Refer to individual widget documentation for used style classes.
408 409 410
 */
#define GTK_STYLE_CLASS_SCROLLBAR "scrollbar"

411 412 413 414
/**
 * GTK_STYLE_CLASS_SCROLLBARS_JUNCTION:
 *
 * A CSS class to match the junction area between an horizontal
415
 * and vertical scrollbar, when they’re both shown.
416 417
 *
 * Refer to individual widget documentation for used style classes.
418 419 420
 */
#define GTK_STYLE_CLASS_SCROLLBARS_JUNCTION "scrollbars-junction"

421 422 423 424
/**
 * GTK_STYLE_CLASS_SCALE:
 *
 * A CSS class to match scale widgets.
425
 *
426
 * Refer to individual widget documentation for used style classes.
427 428 429
 */
#define GTK_STYLE_CLASS_SCALE "scale"

430 431 432 433 434 435
/**
 * 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.
436 437
 *
 * Refer to individual widget documentation for used style classes.
438 439 440 441 442 443 444 445 446
 */
#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.
447 448
 *
 * Refer to individual widget documentation for used style classes.
449 450 451
 */
#define GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW "scale-has-marks-below"

452 453 454 455
/**
 * GTK_STYLE_CLASS_HEADER:
 *
 * A CSS class to match a header element.
456
 *
457
 * Refer to individual widget documentation for used style classes.
458 459 460
 */
#define GTK_STYLE_CLASS_HEADER "header"

461 462 463 464
/**
 * GTK_STYLE_CLASS_ACCELERATOR:
 *
 * A CSS class to match an accelerator.
465
 *
466
 * Refer to individual widget documentation for used style classes.
467 468 469
 */
#define GTK_STYLE_CLASS_ACCELERATOR "accelerator"

470 471 472 473 474
/**
 * GTK_STYLE_CLASS_RAISED:
 *
 * A CSS class to match a raised control, such as a raised
 * button on a toolbar.
475
 *
476
 * Refer to individual widget documentation for used style classes.
477 478 479
 */
#define GTK_STYLE_CLASS_RAISED "raised"

480 481 482 483 484
/**
 * GTK_STYLE_CLASS_LINKED:
 *
 * A CSS class to match a linked area, such as a box containing buttons
 * belonging to the same control.
485 486
 *
 * Refer to individual widget documentation for used style classes.
487 488 489
 */
#define GTK_STYLE_CLASS_LINKED "linked"

490 491 492
/**
 * GTK_STYLE_CLASS_GRIP:
 *
493 494
 * A CSS class defining a resize grip.
 *
495
 * Refer to individual widget documentation for used style classes.
496 497 498
 */
#define GTK_STYLE_CLASS_GRIP "grip"

499 500 501
/**
 * GTK_STYLE_CLASS_DOCK:
 *
502 503
 * A CSS class defining a dock area.
 *
504
 * Refer to individual widget documentation for used style classes.
505 506 507
 */
#define GTK_STYLE_CLASS_DOCK "dock"

508 509 510
/**
 * GTK_STYLE_CLASS_PROGRESSBAR:
 *
511 512
 * A CSS class to use when rendering activity as a progressbar.
 *
513
 * Refer to individual widget documentation for used style classes.
514 515
 */
#define GTK_STYLE_CLASS_PROGRESSBAR "progressbar"
516

517 518 519
/**
 * GTK_STYLE_CLASS_SPINNER:
 *
520
 * A CSS class to use when rendering activity as a “spinner”.
521
 *
522
 * Refer to individual widget documentation for used style classes.
523 524 525
 */
#define GTK_STYLE_CLASS_SPINNER "spinner"

526 527 528
/**
 * GTK_STYLE_CLASS_MARK:
 *
529 530
 * A CSS class defining marks in a widget, such as in scales.
 *
531
 * Refer to individual widget documentation for used style classes.
532 533 534
 */
#define GTK_STYLE_CLASS_MARK "mark"

535 536 537
/**
 * GTK_STYLE_CLASS_EXPANDER:
 *
538 539
 * A CSS class defining an expander, such as those in treeviews.
 *
540
 * Refer to individual widget documentation for used style classes.
541 542 543
 */
#define GTK_STYLE_CLASS_EXPANDER "expander"

544 545 546
/**
 * GTK_STYLE_CLASS_SPINBUTTON:
 *
547 548
 * A CSS class defining an spinbutton.
 *
549
 * Refer to individual widget documentation for used style classes.
550 551 552
 */
#define GTK_STYLE_CLASS_SPINBUTTON "spinbutton"

553 554 555
/**
 * GTK_STYLE_CLASS_NOTEBOOK:
 *
556 557
 * A CSS class defining a notebook.
 *
558
 * Refer to individual widget documentation for used style classes.
559 560 561
 */
#define GTK_STYLE_CLASS_NOTEBOOK "notebook"

562 563 564
/**
 * GTK_STYLE_CLASS_VIEW:
 *
565 566
 * A CSS class defining a view, such as iconviews or treeviews.
 *
567
 * Refer to individual widget documentation for used style classes.
568 569 570
 */
#define GTK_STYLE_CLASS_VIEW "view"

571 572 573
/**
 * GTK_STYLE_CLASS_SIDEBAR:
 *
574 575 576
 * A CSS class defining a sidebar, such as the left side in
 * a file chooser.
 *
577
 * Refer to individual widget documentation for used style classes.
578 579 580
 */
#define GTK_STYLE_CLASS_SIDEBAR "sidebar"

581 582 583
/**
 * GTK_STYLE_CLASS_IMAGE:
 *
584 585
 * A CSS class defining an image, such as the icon in an entry.
 *
586
 * Refer to individual widget documentation for used style classes.
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
 * assistants and calendars.
 *
596
 * Refer to individual widget documentation for used style classes.
597 598 599
 */
#define GTK_STYLE_CLASS_HIGHLIGHT "highlight"

600 601 602
/**
 * GTK_STYLE_CLASS_FRAME:
 *
603 604 605 606
 * A CSS class defining a frame delimiting content, such as
 * #GtkFrame or the scrolled window frame around the
 * scrollable area.
 *
607
 * Refer to individual widget documentation for used style classes.
608 609 610
 */
#define GTK_STYLE_CLASS_FRAME "frame"

611 612 613
/**
 * GTK_STYLE_CLASS_DND:
 *
614 615
 * A CSS class for a drag-and-drop indicator.
 *
616
 * Refer to individual widget documentation for used style classes.
617 618 619
 */
#define GTK_STYLE_CLASS_DND "dnd"

620 621 622 623
/**
 * GTK_STYLE_CLASS_PANE_SEPARATOR:
 *
 * A CSS class for a pane separator, such as those in #GtkPaned.
624
 *
625
 * Refer to individual widget documentation for used style classes.
626 627 628
 */
#define GTK_STYLE_CLASS_PANE_SEPARATOR "pane-separator"

629 630 631 632
/**
 * GTK_STYLE_CLASS_SEPARATOR:
 *
 * A CSS class for a separator.
633
 *
634
 * Refer to individual widget documentation for used style classes.
635 636 637
 */
#define GTK_STYLE_CLASS_SEPARATOR "separator"

638 639 640
/**
 * GTK_STYLE_CLASS_INFO:
 *
641 642 643
 * A CSS class for an area displaying an informational message,
 * such as those in infobars.
 *
644
 * Refer to individual widget documentation for used style classes.
645 646 647 648 649 650
 */
#define GTK_STYLE_CLASS_INFO "info"

/**
 * GTK_STYLE_CLASS_WARNING:
 *
651 652 653
 * A CSS class for an area displaying a warning message,
 * such as those in infobars.
 *
654
 * Refer to individual widget documentation for used style classes.
655 656 657 658 659 660
 */
#define GTK_STYLE_CLASS_WARNING "warning"

/**
 * GTK_STYLE_CLASS_QUESTION:
 *
661 662 663
 * A CSS class for an area displaying a question to the user,
 * such as those in infobars.
 *
664
 * Refer to individual widget documentation for used style classes.
665 666 667 668 669 670
 */
#define GTK_STYLE_CLASS_QUESTION "question"

/**
 * GTK_STYLE_CLASS_ERROR:
 *
671 672 673
 * A CSS class for an area displaying an error message,
 * such as those in infobars.
 *
674
 * Refer to individual widget documentation for used style classes.
675 676 677
 */
#define GTK_STYLE_CLASS_ERROR "error"

678 679 680
/**
 * GTK_STYLE_CLASS_HORIZONTAL:
 *
681 682
 * A CSS class for horizontally layered widgets.
 *
683
 * Refer to individual widget documentation for used style classes.
684 685 686 687 688 689
 */
#define GTK_STYLE_CLASS_HORIZONTAL "horizontal"

/**
 * GTK_STYLE_CLASS_VERTICAL:
 *
690 691
 * A CSS class for vertically layered widgets.
 *
692
 * Refer to individual widget documentation for used style classes.
693 694 695
 */
#define GTK_STYLE_CLASS_VERTICAL "vertical"

696 697 698 699 700
/**
 * GTK_STYLE_CLASS_TOP:
 *
 * A CSS class to indicate an area at the top of a widget.
 *
701
 * Refer to individual widget documentation for used style classes.
702 703 704 705 706 707 708 709
 */
#define GTK_STYLE_CLASS_TOP "top"

/**
 * GTK_STYLE_CLASS_BOTTOM:
 *
 * A CSS class to indicate an area at the bottom of a widget.
 *
710
 * Refer to individual widget documentation for used style classes.
711 712 713 714 715 716 717 718
 */
#define GTK_STYLE_CLASS_BOTTOM "bottom"

/**
 * GTK_STYLE_CLASS_LEFT:
 *
 * A CSS class to indicate an area at the left of a widget.
 *
719
 * Refer to individual widget documentation for used style classes.
720 721 722 723 724 725 726 727
 */
#define GTK_STYLE_CLASS_LEFT "left"

/**
 * GTK_STYLE_CLASS_RIGHT:
 *
 * A CSS class to indicate an area at the right of a widget.
 *
728
 * Refer to individual widget documentation for used style classes.
729 730
 */
#define GTK_STYLE_CLASS_RIGHT "right"
731

732 733 734 735 736
/**
 * GTK_STYLE_CLASS_PULSE:
 *
 * A CSS class to use when rendering a pulse in an indeterminate progress bar.
 *
737
 * Refer to individual widget documentation for used style classes.
738 739 740 741 742 743 744 745
 */
#define GTK_STYLE_CLASS_PULSE "pulse"

/**
 * GTK_STYLE_CLASS_ARROW:
 *
 * A CSS class used when rendering an arrow element.
 *
746
 * Refer to individual widget documentation for used style classes.
747 748 749
 */
#define GTK_STYLE_CLASS_ARROW "arrow"

750 751 752 753 754
/**
 * GTK_STYLE_CLASS_OSD:
 *
 * A CSS class used when rendering an OSD (On Screen Display) element,
 * on top of another container.
755 756
 *
 * Refer to individual widget documentation for used style classes.
757 758 759
 */
#define GTK_STYLE_CLASS_OSD "osd"

760 761 762 763 764 765
/**
 * GTK_STYLE_CLASS_LEVEL_BAR:
 *
 * A CSS class used when rendering a level indicator, such
 * as a battery charge level, or a password strength.
 *
766
 * Refer to individual widget documentation for used style classes.
767 768 769
 */
#define GTK_STYLE_CLASS_LEVEL_BAR "level-bar"

Carlos Garnacho's avatar
Carlos Garnacho committed
770 771 772 773 774
/**
 * GTK_STYLE_CLASS_CURSOR_HANDLE:
 *
 * A CSS class used when rendering a drag handle for
 * text selection.
775 776
 *
 * Refer to individual widget documentation for used style classes.
Carlos Garnacho's avatar
Carlos Garnacho committed
777 778 779
 */
#define GTK_STYLE_CLASS_CURSOR_HANDLE "cursor-handle"

780 781 782 783 784
/**
 * GTK_STYLE_CLASS_INSERTION_CURSOR:
 *
 * A CSS class used when rendering a drag handle for
 * the insertion cursor position.
785 786
 *
 * Refer to individual widget documentation for used style classes.
787 788 789
 */
#define GTK_STYLE_CLASS_INSERTION_CURSOR "insertion-cursor"

790 791 792
/**
 * GTK_STYLE_CLASS_TITLEBAR:
 *
793 794 795
 * A CSS class used when rendering a titlebar in a toplevel window.
 *
 * Refer to individual widget documentation for used style classes.
796 797
 */
#define GTK_STYLE_CLASS_TITLEBAR "titlebar"
798

799 800 801 802 803 804
/**
 * GTK_STYLE_CLASS_TITLE:
 *
 * A CSS class used for the title label in a titlebar in
 * a toplevel window.
 *
805 806
 * Refer to individual widget documentation for used style classes.
 *
807 808 809 810 811 812 813 814 815 816
 * 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.
 *
817 818
 * Refer to individual widget documentation for used style classes.
 *
819 820 821 822
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_SUBTITLE "subtitle"

823 824 825 826 827 828
/**
 * 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.
829 830 831
 *
 * Refer to individual widget documentation for used style classes.
 *
832 833 834 835
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_NEEDS_ATTENTION "needs-attention"

836 837 838 839 840 841
/**
 * GTK_STYLE_CLASS_SUGGESTED_ACTION:
 *
 * A CSS class used when an action (usually a button) is the
 * primary suggested action in a specific context.
 *
842 843
 * Refer to individual widget documentation for used style classes.
 *
844 845 846 847
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_SUGGESTED_ACTION "suggested-action"

848 849 850 851 852 853 854
/**
 * 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.
 *
855 856
 * Refer to individual widget documentation for used style classes.
 *
857 858 859 860
 * Since: 3.12
 */
#define GTK_STYLE_CLASS_DESTRUCTIVE_ACTION "destructive-action"

861 862 863
/**
 * GTK_STYLE_CLASS_POPOVER:
 *
864 865 866
 * A CSS class that matches popovers.
 *
 * Refer to individual widget documentation for used style classes.
867 868 869 870 871
 *
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_POPOVER "popover"

872 873
/* Predefined set of widget regions */

874 875 876 877 878
/**
 * GTK_STYLE_CLASS_POPUP:
 *
 * A CSS class that is added to the toplevel windows used for menus.
 *
879 880
 * Refer to individual widget documentation for used style classes.
 *
881 882 883 884
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_POPUP "popup"

885 886 887 888 889
/**
 * GTK_STYLE_CLASS_MESSAGE_DIALOG:
 *
 * A CSS class that is added to message dialogs.
 *
890 891
 * Refer to individual widget documentation for used style classes.
 *
892 893 894 895
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_MESSAGE_DIALOG "message-dialog"

Matthias Clasen's avatar
Matthias Clasen committed
896 897 898 899 900 901 902
/**
 * 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.
 *
903 904
 * Refer to individual widget documentation for used style classes.
 *
Matthias Clasen's avatar
Matthias Clasen committed
905 906 907 908
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_FLAT "flat"

Matthias Clasen's avatar
Matthias Clasen committed
909 910 911 912
/**
 * GTK_STYLE_CLASS_READ_ONLY:
 *
 * A CSS class used to indicate a read-only state.
913 914
 *
 * Refer to individual widget documentation for used style classes.
Matthias Clasen's avatar
Matthias Clasen committed
915 916 917
 */
#define GTK_STYLE_CLASS_READ_ONLY "read-only"

918
/**
919
 * GTK_STYLE_CLASS_OVERSHOOT:
920
 *
921 922 923 924
 * A CSS class that is added on the visual hints that happen
 * when scrolling is attempted past the limits of a scrollable
 * area.
 *
925 926
 * Refer to individual widget documentation for used style classes.
 *
927 928 929 930
 * Since: 3.14
 */
#define GTK_STYLE_CLASS_OVERSHOOT "overshoot"

931
/**
932
 * GTK_STYLE_CLASS_UNDERSHOOT:
933
 *
934 935 936 937
 * A CSS class that is added on the visual hints that happen
 * where content is 'scrolled off' and can be made visible
 * by scrolling.
 *
938 939
 * Refer to individual widget documentation for used style classes.
 *
940 941 942 943
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_UNDERSHOOT "undershoot"

944
/**
945
 * GTK_STYLE_CLASS_PAPER:
946
 *
947 948 949 950 951
 * 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.
 *
952 953
 * Refer to individual widget documentation for used style classes.
 *
954 955 956 957
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_PAPER "paper"

958 959 960 961 962 963
/**
 * GTK_STYLE_CLASS_MONOSPACE:
 *
 * A CSS class that is added to text view that should use
 * a monospace font.
 *
964 965
 * Refer to individual widget documentation for used style classes.
 *
966 967 968 969
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_MONOSPACE "monospace"

970 971 972 973 974 975
/**
 * GTK_STYLE_CLASS_WIDE:
 *
 * A CSS class to indicate that a UI element should be 'wide'.
 * Used by #GtkPaned.
 *
976 977
 * Refer to individual widget documentation for used style classes.
 *
978 979 980 981
 * Since: 3.16
 */
#define GTK_STYLE_CLASS_WIDE "wide"

982 983 984 985
/**
 * GTK_STYLE_REGION_ROW:
 *
 * A widget region name to define a treeview row.
986 987
 *
 * Deprecated: 3.20: Don't use regions.
988 989 990 991 992 993 994
 */
#define GTK_STYLE_REGION_ROW "row"

/**
 * GTK_STYLE_REGION_COLUMN:
 *
 * A widget region name to define a treeview column.
995 996
 *
 * Deprecated: 3.20: Don't use regions.
997 998 999 1000 1001 1002 1003
 */
#define GTK_STYLE_REGION_COLUMN "column"

/**
 * GTK_STYLE_REGION_COLUMN_HEADER:
 *
 * A widget region name to define a treeview column header.
1004 1005
 *
 * Deprecated: 3.20: Don't use regions.
1006 1007 1008 1009 1010 1011 1012
 */
#define GTK_STYLE_REGION_COLUMN_HEADER "column-header"

/**
 * GTK_STYLE_REGION_TAB:
 *
 * A widget region name to define a notebook tab.
1013 1014
 *
 * Deprecated: 3.20: Don't use regions.
1015 1016 1017
 */
#define GTK_STYLE_REGION_TAB "tab"

1018
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
1019 1020
GType gtk_style_context_get_type (void) G_GNUC_CONST;

1021
GDK_AVAILABLE_IN_ALL
1022 1023
GtkStyleContext * gtk_style_context_new (void);

1024
GDK_AVAILABLE_IN_ALL
1025 1026 1027
void gtk_style_context_add_provider_for_screen    (GdkScreen        *screen,
                                                   GtkStyleProvider *provider,
                                                   guint             priority);
1028
GDK_AVAILABLE_IN_ALL
1029 1030 1031
void gtk_style_context_remove_provider_for_screen (GdkScreen        *screen,
                                                   GtkStyleProvider *provider);

1032
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
1033 1034 1035 1036
void gtk_style_context_add_provider    (GtkStyleContext  *context,
                                        GtkStyleProvider *provider,
                                        guint             priority);

1037
GDK_AVAILABLE_IN_ALL
Carlos Garnacho's avatar
Carlos Garnacho committed
1038 1039 1040
void gtk_style_context_remove_provider (GtkStyleContext  *context,
                                        GtkStyleProvider *provider);

1041
GDK_AVAILABLE_IN_ALL
1042
void gtk_style_context_save    (GtkStyleContext *context);
1043
GDK_AVAILABLE_IN_ALL
1044 1045
void gtk_style_context_restore (GtkStyleContext *context);

1046
GDK_AVAILABLE_IN_ALL
1047 1048
GtkCssSection * gtk_style_context_get_section (GtkStyleContext *context,
                                               const gchar     *property);
1049
GDK_AVAILABLE_IN_ALL
1050 1051
void gtk_style_context_get_property (GtkStyleContext *context,
                                     const gchar     *property,
1052
                                     GtkStateFlags    state,
1053
                                     GValue          *value);
1054
GDK_AVAILABLE_IN_ALL
1055
void gtk_style_context_get_valist   (GtkStyleContext *context,
1056
                                     GtkStateFlags    state,
1057
                                     va_list          args);
1058
GDK_AVAILABLE_IN_ALL
1059
void gtk_style_context_get          (GtkStyleContext *context,
1060
                                     GtkStateFlags    state,
1061 1062
                                     ...) G_GNUC_NULL_TERMINATED;

1063
GDK_AVAILABLE_IN_ALL
1064 1065
void          gtk_style_context_set_state    (GtkStyleContext *context,
                                              GtkStateFlags    flags);
1066
GDK_AVAILABLE_IN_ALL
1067 1068
GtkStateFlags gtk_style_context_get_state    (GtkStyleContext *context);

1069 1070 1071 1072 1073 1074
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);

1075
GDK_DEPRECATED_IN_3_6
1076 1077 1078
gboolean      gtk_style_context_state_is_running (GtkStyleContext *context,
                                                  GtkStateType     state,
                                                  gdouble         *progress);
1079

1080
GDK_AVAILABLE_IN_ALL
1081 1082
void          gtk_style_context_set_path     (GtkStyleContext *context,
                                              GtkWidgetPath   *path);
1083
GDK_AVAILABLE_IN_ALL
1084
const GtkWidgetPath * gtk_style_context_get_path (GtkStyleContext *context);
1085
GDK_AVAILABLE_IN_3_4
1086 1087
void          gtk_style_context_set_parent   (GtkStyleContext *context,
                                              GtkStyleContext *parent);
1088
GDK_AVAILABLE_IN_ALL
1089 1090
GtkStyleContext *gtk_style_context_get_parent (GtkStyleContext *context);

1091
GDK_AVAILABLE_IN_ALL
1092 1093
GList *  gtk_style_context_list_classes (GtkStyleContext *context);

1094
GDK_AVAILABLE_IN_ALL
1095 1096
void     gtk_style_context_add_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
1097
GDK_AVAILABLE_IN_ALL
1098 1099
void     gtk_style_context_remove_class (GtkStyleContext *context,
                                         const gchar     *class_name);
1100
GDK_AVAILABLE_IN_ALL
1101 1102
gboolean gtk_style_context_has_class    (GtkStyleContext *context,
                                         const gchar     *class_name);
1103

1104
GDK_DEPRECATED_IN_3_14
1105 1106
GList *  gtk_style_context_list_regions (GtkStyleContext *context);

1107
GDK_DEPRECATED_IN_3_14
1108 1109 1110
void     gtk_style_context_add_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags      flags);
1111
GDK_DEPRECATED_IN_3_14
1112 1113
void     gtk_style_context_remove_region (GtkStyleContext    *context,
                                          const gchar        *region_name);
1114
GDK_DEPRECATED_IN_3_14
1115 1116 1117
gboolean gtk_style_context_has_region    (GtkStyleContext    *context,
                                          const gchar        *region_name,
                                          GtkRegionFlags     *flags_return);
1118

1119
GDK_AVAILABLE_IN_ALL
1120 1121 1122
void gtk_style_context_get_style_property (GtkStyleContext *context,
                                           const gchar     *property_name,
                                           GValue          *value);
1123
GDK_AVAILABLE_IN_ALL
1124 1125
void gtk_style_context_get_style_valist   (GtkStyleContext *context,
                                           va_list          args);
1126
GDK_AVAILABLE_IN_ALL
1127 1128
void gtk_style_context_get_style          (GtkStyleContext *context,
                                           ...);
1129

1130
GDK_DEPRECATED_IN_3_10_FOR(gtk_icon_theme_lookup_icon)
1131
GtkIconSet * gtk_style_context_lookup_icon_set (GtkStyleContext *context,
1132
                                                const gchar     *stock_id);
1133
GDK_DEPRECATED_IN_3_10
1134 1135 1136
GdkPixbuf  * gtk_icon_set_render_icon_pixbuf   (GtkIconSet      *icon_set,
                                                GtkStyleContext *context,
                                                GtkIconSize      size);
1137
GDK_DEPRECATED_IN_3_10
1138 1139 1140 1141 1142 1143
cairo_surface_t  *
gtk_icon_set_render_icon_surface               (GtkIconSet      *icon_set,
						GtkStyleContext *context,
						GtkIconSize      size,
						int              scale,
						GdkWindow       *for_window);
1144

1145
GDK_AVAILABLE_IN_ALL
1146 1147
void        gtk_style_context_set_screen (GtkStyleContext *context,
                                          GdkScreen       *screen);
1148
GDK_AVAILABLE_IN_ALL
1149 1150
GdkScreen * gtk_style_context_get_screen (GtkStyleContext *context);

1151 1152 1153 1154 1155 1156
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);

1157
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_set_state)
1158 1159
void             gtk_style_context_set_direction (GtkStyleContext  *context,
                                                  GtkTextDirection  direction);
1160
GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get_state)
1161 1162
GtkTextDirection gtk_style_context_get_direction (GtkStyleContext  *context);

1163
GDK_AVAILABLE_IN_ALL
1164
void             gtk_style_context_set_junction_sides (GtkStyleContext  *context,
1165
                                                       GtkJunctionSides  sides);
1166
GDK_AVAILABLE_IN_ALL
1167 1168
GtkJunctionSides gtk_style_context_get_junction_sides (GtkStyleContext  *context);

1169
GDK_AVAILABLE_IN_ALL
1170 1171 1172
gboolean gtk_style_context_lookup_color (GtkStyleContext *context,
                                         const gchar     *color_name,
                                         GdkRGBA         *color);
1173

1174
GDK_DEPRECATED_IN_3_6
1175 1176 1177 1178 1179
void  gtk_style_context_notify_state_change (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gpointer         region_id,
                                             GtkStateType     state,
                                             gboolean         state_value);
1180
GDK_DEPRECATED_IN_3_6
1181 1182
void  gtk_style_context_cancel_animations   (GtkStyleContext *context,
                                             gpointer         region_id);
1183
GDK_DEPRECATED_IN_3_6
1184 1185 1186 1187
void  gtk_style_context_scroll_animations   (GtkStyleContext *context,
                                             GdkWindow       *window,
                                             gint             dx,
                                             gint             dy);
1188

1189
GDK_DEPRECATED_IN_3_6
1190 1191
void gtk_style_context_push_animatable_region (GtkStyleContext *context,
                                               gpointer         region_id);
1192
GDK_DEPRECATED_IN_3_6
1193 1194
void gtk_style_context_pop_animatable_region  (GtkStyleContext *context);

1195
/* Some helper functions to retrieve most common properties */
1196
GDK_AVAILABLE_IN_ALL
1197 1198 1199
void gtk_style_context_get_color            (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1200
GDK_DEPRECATED_IN_3_16_FOR(gtk_render_background)
1201 1202 1203
void gtk_style_context_get_background_color (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1204
GDK_DEPRECATED_IN_3_16_FOR(gtk_render_frame)
1205 1206 1207
void gtk_style_context_get_border_color     (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GdkRGBA         *color);
1208 1209

GDK_DEPRECATED_IN_3_8_FOR(gtk_style_context_get)
1210 1211 1212
const PangoFontDescription *
     gtk_style_context_get_font             (GtkStyleContext *context,
                                             GtkStateFlags    state);
1213
GDK_AVAILABLE_IN_ALL
1214 1215 1216
void gtk_style_context_get_border           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *border);
1217
GDK_AVAILABLE_IN_ALL
1218 1219 1220
void gtk_style_context_get_padding          (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *padding);
1221
GDK_AVAILABLE_IN_ALL
1222 1223 1224
void gtk_style_context_get_margin           (GtkStyleContext *context,
                                             GtkStateFlags    state,
                                             GtkBorder       *margin);
1225

1226
GDK_DEPRECATED_IN_3_12
1227
void gtk_style_context_invalidate           (GtkStyleContext *context);
1228
GDK_AVAILABLE_IN_ALL
1229
void gtk_style_context_reset_widgets        (GdkScreen       *screen);
1230

1231
GDK_DEPRECATED_IN_3_18_FOR(gtk_render_background)
1232 1233
void gtk_style_context_set_background       (GtkStyleContext *context,
                                             GdkWindow       *window);
1234

1235
GDK_AVAILABLE_IN_3_4
1236 1237 1238 1239 1240 1241 1242 1243
void        gtk_render_insertion_cursor
                                   (GtkStyleContext     *context,
                                    cairo_t             *cr,
                                    gdouble              x,
                                    gdouble              y,
                                    PangoLayout         *layout,
                                    int                  index,
                                    PangoDirection       direction);
1244
GDK_DEPRECATED_IN_3_4
1245 1246 1247 1248 1249 1250 1251
void   gtk_draw_insertion_cursor    (GtkWidget          *widget,
                                     cairo_t            *cr,
                                     const GdkRectangle *location,
                                     gboolean            is_primary,
                                     GtkTextDirection    direction,
                                     gboolean            draw_arrow);

1252 1253 1254
typedef enum {
  GTK_STYLE_CONTEXT_PRINT_NONE         = 0,
  GTK_STYLE_CONTEXT_PRINT_RECURSE      = 1 << 0,
1255
  GTK_STYLE_CONTEXT_PRINT_SHOW_STYLE   = 1 << 1
1256 1257 1258 1259 1260 1261
} GtkStyleContextPrintFlags;

GDK_AVAILABLE_IN_3_20
char * gtk_style_context_to_string (GtkStyleContext           *context,
                                    GtkStyleContextPrintFlags  flags);

Carlos Garnacho's avatar
Carlos Garnacho committed
1262 1263 1264
G_END_DECLS

#endif /* __GTK_STYLE_CONTEXT_H__ */