HelpSource/Classes/QPalette.schelp

   1 class:: QPalette
   2 summary:: Set of colors used by the GUI
   3 categories::  GUI>Accessories
   4
   5
   6 Description::
   7
   8 QPalette is a strong::set of colors:: that the GUI system uses to draw the views. The colors are organized into three strong::color groups:: (active, inactive and disabled) used according to the state of the views drawn, and each group containins one color assigned to each of the various strong::color roles:: (window, windowText, button, buttonText, etc.), used to draw distinct elements of the views. See link::Reference/palette_color_roles:: and link::Reference/palette_color_groups:: for details.
   9
  10 A palette can be assigned to the whole GUI using link::Classes/QtGUI#*palette::, or to a particular view using link::Classes/View#-palette::. Views will inherit a palette from their parent, and ultimately QtGUI, unless a palette is explicitely assigned to them. Moreover, when setting a palette on a view, it will be combined with the inherited one, overriding only those colors that have been explicitely set on the palette (see link::#-hasColor::). Hence, assigning a new and unmodified palette will reset all the colors to the inherited ones.
  11
  12 There are also two predefined palettes accessible using link::#*light:: and link::#*dark::. The light palette is assigned to QtGUI by default on startup. Should you wish to use a palette that matches the color scheme used natively on your platform, you can access such palette using link::#*system::.
  13
  14 If you wish to design your own palette, it is most convenient to use link::#*auto::, which will automatically derive a palette from only two colors, and then modify the details as you see fit.
  15
  16 Note that in Qt GUI most color-related methods of views (like link::Classes/Window#-background::, link::Classes/Slider#-knobColor::, etc.) actually modify the view's palette.
  17
  18
  19
  20 CLASSMETHODS::
  21
  22 METHOD:: new
  23         Instantiates a new palette, equivalent to the global palette assigned to QtGUI. All colors are considered to not be set (see link::#-hasColor::).
  24
  25 METHOD:: auto
  26         Instantiates a new palette, with colors automatically derived from the given colors for 'button' and 'window' color roles. All colors are considered to be set (see link::#-hasColor::).
  27
  28         argument:: buttonColor
  29                 The Color assigned to the button role.
  30         argument:: windowColor
  31                 The Color assigned to the window role.
  32
  33 METHOD:: light
  34         A predefined palette using light colors. All colors are considered to be set (see link::#-hasColor::).
  35
  36 METHOD:: dark
  37         A predefined palette using dark colors. All colors are considered to be set (see link::#-hasColor::).
  38
  39 METHOD:: system
  40         The native system palette. All colors are considered to be set (see link::#-hasColor::).
  41
  42
  43 INSTANCEMETHODS::
  44
  45
  46 PRIVATE:: prInit
  47 PRIVATE:: prAuto
  48 PRIVATE:: prSystem
  49 PRIVATE:: prColor
  50 PRIVATE:: prSetColor
  51 PRIVATE:: prHasColor
  52
  53 METHOD:: color
  54         Returns the color assigned to a color role within a color group.
  55         argument:: role
  56                 A symbol among link::Reference/palette_color_roles::.
  57         argument:: group
  58                 A symbol among link::Reference/palette_color_groups::, or nil, in which case the current color group is used.
  59
  60 METHOD:: setColor
  61         Assigns a color to a color role within a color group.
  62
  63         argument:: color
  64                 A Color.
  65         argument:: role
  66                 A symbol among link::Reference/palette_color_roles::.
  67         argument:: group
  68                 A symbol among link::Reference/palette_color_groups::, or nil, in which case the color will be assigned to all groups.
  69
  70 METHOD:: hasColor
  71         Whether the color belonging to a color role and group has been set on this QPalette instance.
  72
  73         When setting a palette on a view, only colors for which this methods returns true will be changed, others will be inherited from the parent view (or QtGUI if this view has no parent).
  74
  75         argument:: role
  76                 A symbol among link::Reference/palette_color_roles::.
  77         argument:: group
  78                 A symbol among link::Reference/palette_color_groups::.
  79
  80 METHOD:: window
  81         Convenience method to get or set the color for the 'window' role.
  82
  83 METHOD:: windowText
  84         Convenience method to get or set the color for the 'windowText' role.
  85
  86 METHOD:: button
  87         Convenience method to get or set the color for the 'button' role.
  88
  89 METHOD:: buttonText
  90         Convenience method to get or set the color for the 'buttonText' role.
  91
  92 METHOD:: base
  93         Convenience method to get or set the color for the 'base' role.
  94
  95 METHOD:: baseText
  96         Convenience method to get or set the color for the 'baseText' role.
  97
  98 METHOD:: highlight
  99         Convenience method to get or set the color for the 'highlight' role.
 100
 101 METHOD:: highlightText
 102         Convenience method to get or set the color for the 'highlightText' role.