diff options
Diffstat (limited to 'doc/html/qcolorgroup.html')
| -rw-r--r-- | doc/html/qcolorgroup.html | 346 |
1 files changed, 346 insertions, 0 deletions
diff --git a/doc/html/qcolorgroup.html b/doc/html/qcolorgroup.html new file mode 100644 index 0000000..6bea37f --- /dev/null +++ b/doc/html/qcolorgroup.html @@ -0,0 +1,346 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qpalette.cpp:48 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QColorGroup Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QColorGroup Class Reference</h1> + +<p>The QColorGroup class contains a group of widget colors. +<a href="#details">More...</a> +<p><tt>#include <<a href="qpalette-h.html">qpalette.h</a>></tt> +<p><a href="qcolorgroup-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QColorGroup"><b>QColorGroup</b></a> ()</li> +<li class=fn>QColorGroup ( const QColor & foreground, const QColor & background, const QColor & light, const QColor & dark, const QColor & mid, const QColor & text, const QColor & base ) <em>(obsolete)</em></li> +<li class=fn><a href="#QColorGroup-3"><b>QColorGroup</b></a> ( const QBrush & foreground, const QBrush & button, const QBrush & light, const QBrush & dark, const QBrush & mid, const QBrush & text, const QBrush & bright_text, const QBrush & base, const QBrush & background )</li> +<li class=fn><a href="#QColorGroup-4"><b>QColorGroup</b></a> ( const QColorGroup & other )</li> +<li class=fn><a href="#~QColorGroup"><b>~QColorGroup</b></a> ()</li> +<li class=fn>QColorGroup & <a href="#operator-eq"><b>operator=</b></a> ( const QColorGroup & other )</li> +<li class=fn>enum <a href="#ColorRole-enum"><b>ColorRole</b></a> { Foreground, Button, Light, Midlight, Dark, Mid, Text, BrightText, ButtonText, Base, Background, Shadow, Highlight, HighlightedText, Link, LinkVisited, NColorRoles }</li> +<li class=fn>const QColor & <a href="#color"><b>color</b></a> ( ColorRole r ) const</li> +<li class=fn>const QBrush & <a href="#brush"><b>brush</b></a> ( ColorRole r ) const</li> +<li class=fn>void <a href="#setColor"><b>setColor</b></a> ( ColorRole r, const QColor & c )</li> +<li class=fn>void <a href="#setBrush"><b>setBrush</b></a> ( ColorRole r, const QBrush & b )</li> +<li class=fn>const QColor & <a href="#foreground"><b>foreground</b></a> () const</li> +<li class=fn>const QColor & <a href="#button"><b>button</b></a> () const</li> +<li class=fn>const QColor & <a href="#light"><b>light</b></a> () const</li> +<li class=fn>const QColor & <a href="#dark"><b>dark</b></a> () const</li> +<li class=fn>const QColor & <a href="#mid"><b>mid</b></a> () const</li> +<li class=fn>const QColor & <a href="#text"><b>text</b></a> () const</li> +<li class=fn>const QColor & <a href="#base"><b>base</b></a> () const</li> +<li class=fn>const QColor & <a href="#background"><b>background</b></a> () const</li> +<li class=fn>const QColor & <a href="#midlight"><b>midlight</b></a> () const</li> +<li class=fn>const QColor & <a href="#brightText"><b>brightText</b></a> () const</li> +<li class=fn>const QColor & <a href="#buttonText"><b>buttonText</b></a> () const</li> +<li class=fn>const QColor & <a href="#shadow"><b>shadow</b></a> () const</li> +<li class=fn>const QColor & <a href="#highlight"><b>highlight</b></a> () const</li> +<li class=fn>const QColor & <a href="#highlightedText"><b>highlightedText</b></a> () const</li> +<li class=fn>const QColor & <a href="#link"><b>link</b></a> () const</li> +<li class=fn>const QColor & <a href="#linkVisited"><b>linkVisited</b></a> () const</li> +<li class=fn>bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const QColorGroup & g ) const</li> +<li class=fn>bool <a href="#operator!-eq"><b>operator!=</b></a> ( const QColorGroup & g ) const</li> +</ul> +<h2>Related Functions</h2> +<ul> +<li class=fn>QDataStream & <a href="#operator-lt-lt"><b>operator<<</b></a> ( QDataStream & s, const QColorGroup & g )</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QColorGroup class contains a group of widget colors. +<p> + + +<p> A color group contains a group of colors used by widgets for +drawing themselves. We recommend that widgets use color group +roles such as "foreground" and "base" rather than literal colors +like "red" or "turquoise". The color roles are enumerated and +defined in the <a href="#ColorRole-enum">ColorRole</a> documentation. +<p> The most common use of QColorGroup is like this: +<p> <pre> + <a href="qpainter.html">QPainter</a> p; + ... + p.<a href="qpainter.html#setPen">setPen</a>( colorGroup().foreground() ); + p.<a href="qpainter.html#drawLine">drawLine</a>( ... ) + </pre> + +<p> It is also possible to modify color groups or create new color +groups from scratch. +<p> The color group class can be created using three different +constructors or by modifying one supplied by Qt. The default +constructor creates an all-black color group, which can then be +modified using set functions; there's also a constructor for +specifying all the color group colors. And there is also a copy +constructor. +<p> We strongly recommend using a system-supplied color group and +modifying that as necessary. +<p> You modify a color group by calling the access functions +<a href="#setColor">setColor</a>() and <a href="#setBrush">setBrush</a>(), depending on whether you want a pure +color or a pixmap pattern. +<p> There are also corresponding <a href="#color">color</a>() and <a href="#brush">brush</a>() getters, and a +commonly used convenience function to get each ColorRole: +<a href="#background">background</a>(), <a href="#foreground">foreground</a>(), <a href="#base">base</a>(), etc. +<p> <p>See also <a href="qcolor.html">QColor</a>, <a href="qpalette.html">QPalette</a>, <a href="qwidget.html#colorGroup-prop">QWidget::colorGroup</a>, <a href="appearance.html">Widget Appearance and Style</a>, <a href="graphics.html">Graphics Classes</a>, and <a href="images.html">Image Processing Classes</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="ColorRole-enum"></a>QColorGroup::ColorRole</h3> + +<p> The ColorRole enum defines the different symbolic color roles used +in current GUIs. +<p> The central roles are: +<ul> +<li><tt>QColorGroup::Background</tt> - general background color. +<li><tt>QColorGroup::Foreground</tt> - general foreground color. +<li><tt>QColorGroup::Base</tt> - used as background color for text entry widgets, for example; +usually white or another light color. +<li><tt>QColorGroup::Text</tt> - the foreground color used with <a href="#ColorRole-enum">Base</a>. Usually this +is the same as the <a href="#ColorRole-enum">Foreground</a>, in which case it must provide good +contrast with <a href="#ColorRole-enum">Background</a> and <a href="#ColorRole-enum">Base</a>. +<li><tt>QColorGroup::Button</tt> - general button background color in which buttons need a +background different from <a href="#ColorRole-enum">Background</a>, as in the Macintosh style. +<li><tt>QColorGroup::ButtonText</tt> - a foreground color used with the <a href="#ColorRole-enum">Button</a> color. +</ul><p> There are some color roles used mostly for 3D bevel and shadow +effects: +<ul> +<li><tt>QColorGroup::Light</tt> - lighter than <a href="#ColorRole-enum">Button</a> color. +<li><tt>QColorGroup::Midlight</tt> - between <a href="#ColorRole-enum">Button</a> and <a href="#ColorRole-enum">Light</a>. +<li><tt>QColorGroup::Dark</tt> - darker than <a href="#ColorRole-enum">Button</a>. +<li><tt>QColorGroup::Mid</tt> - between <a href="#ColorRole-enum">Button</a> and <a href="#ColorRole-enum">Dark</a>. +<li><tt>QColorGroup::Shadow</tt> - a very dark color. +By default, the shadow color is <tt>Qt::black</tt>. +</ul><p> All of these are normally derived from <a href="#ColorRole-enum">Background</a> and used in +ways that depend on that relationship. For example, buttons depend +on it to make the bevels look attractive, and <a href="motif-extension.html#Motif">Motif</a> scroll bars +depend on <a href="#ColorRole-enum">Mid</a> to be slightly different from <a href="#ColorRole-enum">Background</a>. +<p> Selected (marked) items have two roles: +<ul> +<li><tt>QColorGroup::Highlight</tt> - a color to indicate a selected item or the +current item. By default, the highlight color is <tt>Qt::darkBlue</tt>. +<li><tt>QColorGroup::HighlightedText</tt> - a text color that contrasts with <a href="#ColorRole-enum">Highlight</a>. +By default, the highlighted text color is <tt>Qt::white</tt>. +</ul><p> Finally, there is a special role for text that needs to be +drawn where <a href="#ColorRole-enum">Text</a> or <a href="#ColorRole-enum">Foreground</a> would give poor contrast, +such as on pressed push buttons: +<ul> +<li><tt>QColorGroup::BrightText</tt> - a text color that is very different from <a href="#ColorRole-enum">Foreground</a> and contrasts well with e.g. <a href="#ColorRole-enum">Dark</a>. +<li><tt>QColorGroup::Link</tt> - a text color used for unvisited hyperlinks. +By default, the link color is <tt>Qt::blue</tt>. +<li><tt>QColorGroup::LinkVisited</tt> - a text color used for already visited hyperlinks. +By default, the linkvisited color is <tt>Qt::magenta</tt>. +<li><tt>QColorGroup::NColorRoles</tt> - Internal. +</ul><p> Note that text colors can be used for things other than just +words; text colors are <em>usually</em> used for text, but it's quite +common to use the text color roles for lines, icons, etc. +<p> This image shows most of the color roles in use: +<center><img src="palette.png" alt="Color Roles"></center> +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QColorGroup"></a>QColorGroup::QColorGroup () +</h3> +Constructs a color group with all colors set to black. + +<h3 class=fn><a name="QColorGroup-2"></a>QColorGroup::QColorGroup ( const <a href="qcolor.html">QColor</a> & foreground, const <a href="qcolor.html">QColor</a> & background, const <a href="qcolor.html">QColor</a> & light, const <a href="qcolor.html">QColor</a> & dark, const <a href="qcolor.html">QColor</a> & mid, const <a href="qcolor.html">QColor</a> & text, const <a href="qcolor.html">QColor</a> & base ) +</h3><b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> Constructs a color group with the specified colors. The button +color will be set to the background color. + +<h3 class=fn><a name="QColorGroup-3"></a>QColorGroup::QColorGroup ( const <a href="qbrush.html">QBrush</a> & foreground, const <a href="qbrush.html">QBrush</a> & button, const <a href="qbrush.html">QBrush</a> & light, const <a href="qbrush.html">QBrush</a> & dark, const <a href="qbrush.html">QBrush</a> & mid, const <a href="qbrush.html">QBrush</a> & text, const <a href="qbrush.html">QBrush</a> & bright_text, const <a href="qbrush.html">QBrush</a> & base, const <a href="qbrush.html">QBrush</a> & background ) +</h3> +Constructs a color group. You can pass either brushes, pixmaps or +plain colors for <em>foreground</em>, <em>button</em>, <em>light</em>, <em>dark</em>, <em>mid</em>, <em>text</em>, <em>bright_text</em>, <em>base</em> and <em>background</em>. +<p> <p>See also <a href="qbrush.html">QBrush</a>. + +<h3 class=fn><a name="QColorGroup-4"></a>QColorGroup::QColorGroup ( const <a href="qcolorgroup.html">QColorGroup</a> & other ) +</h3> +Constructs a color group that is an independent copy of <em>other</em>. + +<h3 class=fn><a name="~QColorGroup"></a>QColorGroup::~QColorGroup () +</h3> +Destroys the color group. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="background"></a>QColorGroup::background () const +</h3> + +<p> Returns the background color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="base"></a>QColorGroup::base () const +</h3> + +<p> Returns the base color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="brightText"></a>QColorGroup::brightText () const +</h3> + +<p> Returns the bright text foreground color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x273">themes/metal.cpp</a> and <a href="themes-example.html#x194">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qbrush.html">QBrush</a> & <a name="brush"></a>QColorGroup::brush ( <a href="qcolorgroup.html#ColorRole-enum">ColorRole</a> r ) const +</h3> +Returns the brush that has been set for color role <em>r</em>. +<p> <p>See also <a href="#color">color</a>(), <a href="#setBrush">setBrush</a>(), and <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x274">themes/metal.cpp</a> and <a href="themes-example.html#x195">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="button"></a>QColorGroup::button () const +</h3> + +<p> Returns the button color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x275">themes/metal.cpp</a> and <a href="themes-example.html#x196">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="buttonText"></a>QColorGroup::buttonText () const +</h3> + +<p> Returns the button text foreground color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x276">themes/metal.cpp</a> and <a href="themes-example.html#x197">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="color"></a>QColorGroup::color ( <a href="qcolorgroup.html#ColorRole-enum">ColorRole</a> r ) const +</h3> +Returns the color that has been set for color role <em>r</em>. +<p> <p>See also <a href="#brush">brush</a>() and <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="dark"></a>QColorGroup::dark () const +</h3> + +<p> Returns the dark color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Example: <a href="themes-example.html#x198">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="foreground"></a>QColorGroup::foreground () const +</h3> + +<p> Returns the foreground color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x277">themes/metal.cpp</a> and <a href="themes-example.html#x199">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="highlight"></a>QColorGroup::highlight () const +</h3> + +<p> Returns the highlight color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="highlightedText"></a>QColorGroup::highlightedText () const +</h3> + +<p> Returns the highlighted text color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="light"></a>QColorGroup::light () const +</h3> + +<p> Returns the light color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Example: <a href="themes-example.html#x200">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="link"></a>QColorGroup::link () const +</h3> + +<p> Returns the unvisited link text color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="linkVisited"></a>QColorGroup::linkVisited () const +</h3> + +<p> Returns the visited link text color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="mid"></a>QColorGroup::mid () const +</h3> + +<p> Returns the mid color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="themes-example.html#x278">themes/metal.cpp</a> and <a href="themes-example.html#x201">themes/wood.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="midlight"></a>QColorGroup::midlight () const +</h3> + +<p> Returns the midlight color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>bool <a name="operator!-eq"></a>QColorGroup::operator!= ( const <a href="qcolorgroup.html">QColorGroup</a> & g ) const +</h3> + +<p> Returns TRUE if this color group is different from <em>g</em>; otherwise +returns FALSE. +<p> <p>See also +<h3 class=fn><a href="qcolorgroup.html">QColorGroup</a> & <a name="operator-eq"></a>QColorGroup::operator= ( const <a href="qcolorgroup.html">QColorGroup</a> & other ) +</h3> +Copies the colors of <em>other</em> to this color group. + +<h3 class=fn>bool <a name="operator-eq-eq"></a>QColorGroup::operator== ( const <a href="qcolorgroup.html">QColorGroup</a> & g ) const +</h3> +Returns TRUE if this color group is equal to <em>g</em>; otherwise +returns FALSE. +<p> <p>See also +<h3 class=fn>void <a name="setBrush"></a>QColorGroup::setBrush ( <a href="qcolorgroup.html#ColorRole-enum">ColorRole</a> r, const <a href="qbrush.html">QBrush</a> & b ) +</h3> +Sets the brush used for color role <em>r</em> to <em>b</em>. +<p> <p>See also <a href="#brush">brush</a>(), <a href="#setColor">setColor</a>(), and <a href="#ColorRole-enum">ColorRole</a>. + +<p>Example: <a href="themes-example.html#x202">themes/wood.cpp</a>. +<h3 class=fn>void <a name="setColor"></a>QColorGroup::setColor ( <a href="qcolorgroup.html#ColorRole-enum">ColorRole</a> r, const <a href="qcolor.html">QColor</a> & c ) +</h3> +Sets the brush used for color role <em>r</em> to a solid color <em>c</em>. +<p> <p>See also <a href="#brush">brush</a>() and <a href="#ColorRole-enum">ColorRole</a>. + +<p>Examples: <a href="listviews-example.html#x134">listviews/listviews.cpp</a>, <a href="statistics-example.html#x2779">table/statistics/statistics.cpp</a>, and <a href="themes-example.html#x279">themes/metal.cpp</a>. +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="shadow"></a>QColorGroup::shadow () const +</h3> + +<p> Returns the shadow color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<h3 class=fn>const <a href="qcolor.html">QColor</a> & <a name="text"></a>QColorGroup::text () const +</h3> + +<p> Returns the text foreground color of the color group. +<p> <p>See also <a href="#ColorRole-enum">ColorRole</a>. + +<p>Example: <a href="listviews-example.html#x135">listviews/listviews.cpp</a>. +<hr><h2>Related Functions</h2> +<h3 class=fn><a href="qdatastream.html">QDataStream</a> & <a name="operator-lt-lt"></a>operator<< ( <a href="qdatastream.html">QDataStream</a> & s, const <a href="qcolorgroup.html">QColorGroup</a> & g ) +</h3> + +<p> Writes color group, <em>g</em> to the stream <em>s</em>. +<p> <p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |