Skip to content
Snippets Groups Projects
qml-qtquick-systempalette.html 14.7 KiB
Newer Older
  • Learn to ignore specific revisions
  • <!DOCTYPE html>
    <html lang="en">
    <head>
      <meta charset="utf-8">
    <!-- qquicksystempalette.cpp -->
      <title>SystemPalette QML Type | Qt Quick 5.15.0</title>
      <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
      <script type="text/javascript">
        document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
        // loading style sheet breaks anchors that were jumped to before
        // so force jumping to anchor again
        setTimeout(function() {
            var anchor = location.hash;
            // need to jump to different anchor first (e.g. none)
            location.hash = "#";
            setTimeout(function() {
                location.hash = anchor;
            }, 0);
        }, 0);
      </script>
    </head>
    <body>
    <div class="header" id="qtdocheader">
        <div class="main">
        <div class="main-rounded">
            <div class="navigationbar">
            <ul>
    <li><a href="../qtdoc/index.html">Qt 5.15</a></li>
    <li><a href="qtquick-index.html">Qt Quick</a></li>
    <li><a href="qtquick-qmlmodule.html">QML Types</a></li>
    <li>SystemPalette QML Type</li>
    <li id="buildversion"><a href="qtquick-index.html">Qt 5.15.0 Reference Documentation</a></li>
        </ul>
        </div>
    </div>
    <div class="content">
    <div class="line">
    <div class="content mainContent">
    <div class="sidebar">
    <div class="toc">
    <h3><a name="toc">Contents</a></h3>
    <ul>
    <li class="level1"><a href="#properties">Properties</a></li>
    <li class="level1"><a href="#details">Detailed Description</a></li>
    </ul>
    </div>
    <div class="sidebar-content" id="sidebar-content"></div></div>
    <h1 class="title">SystemPalette QML Type</h1>
    <span class="subtitle"></span>
    <!-- $$$SystemPalette-brief -->
    <p>Provides access to the Qt palettes. <a href="#details">More...</a></p>
    <!-- @@@SystemPalette -->
    <div class="table"><table class="alignedsummary">
    <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.15</td></tr></table></div><ul>
    <li><a href="qml-qtquick-systempalette-members.html">List of all members, including inherited members</a></li>
    </ul>
    <a name="properties"></a>
    <h2 id="properties">Properties</h2>
    <ul>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#alternateBase-prop">alternateBase</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#base-prop">base</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#button-prop">button</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#buttonText-prop">buttonText</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#colorGroup-prop">colorGroup</a></b></b> : enumeration</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#dark-prop">dark</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#highlight-prop">highlight</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#highlightedText-prop">highlightedText</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#light-prop">light</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#mid-prop">mid</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#midlight-prop">midlight</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#shadow-prop">shadow</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#text-prop">text</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#window-prop">window</a></b></b> : color</li>
    <li class="fn"><b><b><a href="qml-qtquick-systempalette.html#windowText-prop">windowText</a></b></b> : color</li>
    </ul>
    <!-- $$$SystemPalette-description -->
    <a name="details"></a>
    <h2 id="details">Detailed Description</h2>
    <p>The SystemPalette type provides access to the Qt application palettes. This provides information about the standard colors used for application windows, buttons and other features. These colors are grouped into three <i>color groups</i>: <code>Active</code>, <code>Inactive</code>, and <code>Disabled</code>. See the <a href="../qtgui/qpalette.html">QPalette</a> documentation for details about color groups and the properties provided by SystemPalette.</p>
    <p>This can be used to color items in a way that provides a more native look and feel.</p>
    <p>The following example creates a palette from the <code>Active</code> color group and uses this to color the window and text items appropriately:</p>
    <pre class="qml">
     import QtQuick 2.0
    
     <span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
         <span class="type"><a href="qml-qtquick-systempalette.html">SystemPalette</a></span> { <span class="name">id</span>: <span class="name">myPalette</span>; <span class="name">colorGroup</span>: <span class="name">SystemPalette</span>.<span class="name">Active</span> }
    
         <span class="name">width</span>: <span class="number">640</span>; <span class="name">height</span>: <span class="number">480</span>
         <span class="name">color</span>: <span class="name">myPalette</span>.<span class="name">window</span>
    
         <span class="type"><a href="qml-qtquick-text.html">Text</a></span> {
             <span class="name">anchors</span>.fill: <span class="name">parent</span>
             <span class="name">text</span>: <span class="string">&quot;Hello!&quot;</span>; <span class="name">color</span>: <span class="name">myPalette</span>.<span class="name">windowText</span>
         }
     }
    </pre>
    <p><b>See also </b><a href="../qtgui/qpalette.html">QPalette</a>.</p>
    <!-- @@@SystemPalette -->
    <h2>Property Documentation</h2>
    <!-- $$$alternateBase -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="alternateBase-prop">
    <td class="tblQmlPropNode"><p>
    <a name="alternateBase-prop"></a><span class="name">alternateBase</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The alternate base color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@alternateBase -->
    <br/>
    <!-- $$$base -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="base-prop">
    <td class="tblQmlPropNode"><p>
    <a name="base-prop"></a><span class="name">base</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The base color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@base -->
    <br/>
    <!-- $$$button -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="button-prop">
    <td class="tblQmlPropNode"><p>
    <a name="button-prop"></a><span class="name">button</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The button color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@button -->
    <br/>
    <!-- $$$buttonText -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="buttonText-prop">
    <td class="tblQmlPropNode"><p>
    <a name="buttonText-prop"></a><span class="name">buttonText</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The button text foreground color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@buttonText -->
    <br/>
    <!-- $$$colorGroup -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="colorGroup-prop">
    <td class="tblQmlPropNode"><p>
    <a name="colorGroup-prop"></a><span class="name">colorGroup</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The color group of the palette. This can be one of:</p>
    <ul>
    <li><a href="qml-qtquick-systempalette.html">SystemPalette</a>.Active (default)</li>
    <li><a href="qml-qtquick-systempalette.html">SystemPalette</a>.Inactive</li>
    <li><a href="qml-qtquick-systempalette.html">SystemPalette</a>.Disabled</li>
    </ul>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorGroup-enum">QPalette::ColorGroup</a>.</p>
    </div></div><!-- @@@colorGroup -->
    <br/>
    <!-- $$$dark -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="dark-prop">
    <td class="tblQmlPropNode"><p>
    <a name="dark-prop"></a><span class="name">dark</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The dark color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@dark -->
    <br/>
    <!-- $$$highlight -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="highlight-prop">
    <td class="tblQmlPropNode"><p>
    <a name="highlight-prop"></a><span class="name">highlight</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The highlight color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@highlight -->
    <br/>
    <!-- $$$highlightedText -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="highlightedText-prop">
    <td class="tblQmlPropNode"><p>
    <a name="highlightedText-prop"></a><span class="name">highlightedText</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The highlighted text color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@highlightedText -->
    <br/>
    <!-- $$$light -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="light-prop">
    <td class="tblQmlPropNode"><p>
    <a name="light-prop"></a><span class="name">light</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The light color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@light -->
    <br/>
    <!-- $$$mid -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="mid-prop">
    <td class="tblQmlPropNode"><p>
    <a name="mid-prop"></a><span class="name">mid</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The mid color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@mid -->
    <br/>
    <!-- $$$midlight -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="midlight-prop">
    <td class="tblQmlPropNode"><p>
    <a name="midlight-prop"></a><span class="name">midlight</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The midlight color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@midlight -->
    <br/>
    <!-- $$$shadow -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="shadow-prop">
    <td class="tblQmlPropNode"><p>
    <a name="shadow-prop"></a><span class="name">shadow</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The shadow color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@shadow -->
    <br/>
    <!-- $$$text -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="text-prop">
    <td class="tblQmlPropNode"><p>
    <a name="text-prop"></a><span class="name">text</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The text color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@text -->
    <br/>
    <!-- $$$window -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="window-prop">
    <td class="tblQmlPropNode"><p>
    <a name="window-prop"></a><span class="name">window</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The window (general background) color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@window -->
    <br/>
    <!-- $$$windowText -->
    <div class="qmlitem"><div class="qmlproto">
    <div class="table"><table class="qmlname">
    <tr valign="top" class="odd" id="windowText-prop">
    <td class="tblQmlPropNode"><p>
    <a name="windowText-prop"></a><span class="name">windowText</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr>
    </table></div></div>
    <div class="qmldoc"><p>The window text (general foreground) color of the current color group.</p>
    <p><b>See also </b><a href="../qtgui/qpalette.html#ColorRole-enum">QPalette::ColorRole</a>.</p>
    </div></div><!-- @@@windowText -->
    <br/>
            </div>
           </div>
       </div>
       </div>
    </div>
    <div class="footer">
       <p>
       <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
       Documentation contributions included herein are the copyrights of
       their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
       of their respective owners. </p>
    </div>
    </body>
    </html>