1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.SystemSettings:
==========================================================================================================================================
|phoenix_title| **wx.SystemSettings**
==========================================================================================================================================
:ref:`wx.SystemSettings` allows the application to ask for details about the system.
This can include settings such as standard colours, fonts, and user interface element sizes.
.. seealso:: :ref:`wx.Font`, :ref:`wx.Colour`, :ref:`wx.SystemOptions`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>SystemSettings</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.SystemSettings_inheritance.png" alt="Inheritance diagram of SystemSettings" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.SystemSettings.html" title="wx.SystemSettings" alt="" coords="5,5,149,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SystemSettings.__init__` Default constructor.
:meth:`~wx.SystemSettings.GetColour` Returns a system colour.
:meth:`~wx.SystemSettings.GetFont` Returns a system font.
:meth:`~wx.SystemSettings.GetMetric` Returns the value of a system metric, or -1 if the metric is not supported on the current system.
:meth:`~wx.SystemSettings.GetScreenType` Returns the screen type.
:meth:`~wx.SystemSettings.HasFeature` Returns ``True`` if the port has certain feature.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SystemSettings(object)
**Possible constructors**::
SystemSettings()
SystemSettings allows the application to ask for details about the
system.
.. method:: __init__(self)
Default constructor.
You don't need to create an instance of :ref:`wx.SystemSettings` since all of its functions are static.
.. staticmethod:: GetColour(index)
Returns a system colour.
:param `index`: Can be one of the :ref:`wx.SystemColour` enum values.
:type `index`: wx.SystemColour
:rtype: :ref:`wx.Colour`
:returns:
The returned colour is always valid.
.. staticmethod:: GetFont(index)
Returns a system font.
:param `index`: Can be one of the :ref:`wx.SystemFont` enum values.
:type `index`: wx.SystemFont
:rtype: :ref:`wx.Font`
:returns:
The returned font is always valid.
.. staticmethod:: GetMetric(index, win=None)
Returns the value of a system metric, or -1 if the metric is not supported on the current system.
The value of `win` determines if the metric returned is a global value or a :ref:`wx.Window` based value, in which case it might determine the widget, the display the window is on, or something similar. The window given should be as close to the metric as possible (e.g. a :ref:`wx.TopLevelWindow` in case of the ``wx.SYS_CAPTION_Y`` metric).
`index` can be one of the :ref:`wx.SystemMetric` enum values.
`win` is a pointer to the window for which the metric is requested. Specifying the `win` parameter is encouraged, because some metrics on some ports are not supported without one,or they might be capable of reporting better values if given one. If a window does not make sense for a metric, one should still be given, as for example it might determine which displays cursor width is requested with ``wx.SYS_CURSOR_X``.
:param `index`:
:type `index`: wx.SystemMetric
:param `win`:
:type `win`: wx.Window
:rtype: `int`
.. staticmethod:: GetScreenType()
Returns the screen type.
The return value is one of the :ref:`wx.SystemScreenType` enum values.
:rtype: :ref:`wx.SystemScreenType`
.. staticmethod:: HasFeature(index)
Returns ``True`` if the port has certain feature.
See the :ref:`wx.SystemFeature` enum values.
:param `index`:
:type `index`: wx.SystemFeature
:rtype: `bool`
|