<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxSystemSettings</title>
</header>
<module>wxSystemSettings</module>
<modulesummary>Functions for wxSystemSettings class</modulesummary>
<description><p><seeerl marker="wxSystemSettings"><c>wxSystemSettings</c></seeerl> allows the application to ask for details about the system.
      </p><p>This can include settings such as standard colours, fonts, and user interface element sizes.
      </p><p>See: <seeerl marker="wxFont"><c>wxFont</c></seeerl>, <seetype marker="wx#wx_colour"><c>wx_color()</c></seetype>, <seeerl marker="wxSystemOptions"><c>wxSystemOptions</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_system_settings.html">wxSystemSettings</url></p>
  </description>
<datatypes><datatype><name name="wxSystemSettings"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a system colour. </fsummary>
    <desc><p>Returns a system colour. 
      </p><p>Return: The returned colour is always valid. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a system font. </fsummary>
    <desc><p>Returns a system font. 
      </p><p>Return: The returned font is always valid. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMetric" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>getMetric/2</c></fsummary>
  </func>
  
  <func>
    <name name="getMetric" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the value of a system metric, or -1 if the metric is not supported on the current system. </fsummary>
    <desc><p>Returns the value of a system metric, or -1 if the metric is not supported on the current system. 
      </p><p>The value of <c>win</c> determines if the metric returned is a global value or a <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> 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 <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> in case of the wxSYS_CAPTION_Y metric).
      </p><p><c>index</c> can be one of the ?wxSystemMetric enum values.
      </p><p><c>win</c> is a pointer to the window for which the metric is requested. Specifying the <c>win</c> 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 wxSYS_CURSOR_X. 
      </p></desc>
  </func>
  
  <func>
    <name name="getScreenType" arity="0" clause_i="1" since=""/>
    <fsummary>Returns the screen type. </fsummary>
    <desc><p>Returns the screen type. 
      </p><p>The return value is one of the ?wxSystemScreenType enum values. 
      </p></desc>
  </func>
  </funcs>
</erlref>
