<?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>wxDisplay</title>
</header>
<module>wxDisplay</module>
<modulesummary>Functions for wxDisplay class</modulesummary>
<description><p>Determines the sizes and locations of displays connected to the system.
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_display.html">wxDisplay</url></p>
  </description>
<datatypes><datatype><name name="wxDisplay"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor creating <c>wxDisplay</c> object representing the primary display. </fsummary>
    <desc><p>Default constructor creating <seeerl marker="wxDisplay"><c>wxDisplay</c></seeerl> object representing the primary display. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
  
    <name name="new" arity="1" clause_i="2" since=""/>
    <fsummary>Constructor creating the display object associated with the given window. </fsummary>
    <desc><p>Constructor creating the display object associated with the given window. 
      </p><p>This is the most convenient way of finding the display on which the given window is shown while falling back to the default display if it is not shown at all or positioned outside of any display.
      </p><p>See: <seemfa marker="#getFromWindow/1"><c>getFromWindow/1</c></seemfa>
      </p><p>Since: 3.1.2 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="isOk" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the object was initialized successfully. </fsummary>
    <desc><p>Returns true if the object was initialized successfully. 
      </p></desc>
  </func>
  
  <func>
    <name name="getClientArea" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the client area of the display. </fsummary>
    <desc><p>Returns the client area of the display. 
      </p><p>The client area is the part of the display available for the normal (non full screen) windows, usually it is the same as <seemfa marker="#getGeometry/1"><c>getGeometry/1</c></seemfa> but it could be less if there is a taskbar (or equivalent) on this display. 
      </p></desc>
  </func>
  
  <func>
    <name name="getGeometry" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the bounding rectangle of the display whose index was passed to the constructor. </fsummary>
    <desc><p>Returns the bounding rectangle of the display whose index was passed to the constructor. 
      </p><p>See: <seemfa marker="#getClientArea/1"><c>getClientArea/1</c></seemfa>, <seemfa marker="wx_misc#displaySize/0"><c>wx_misc:displaySize/0</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getName" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the display's name. </fsummary>
    <desc><p>Returns the display's name. 
      </p><p>The returned value is currently an empty string under all platforms except MSW. 
      </p></desc>
  </func>
  
  <func>
    <name name="isPrimary" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the display is the primary display. </fsummary>
    <desc><p>Returns true if the display is the primary display. 
      </p><p>The primary display is the one whose index is 0. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCount" arity="0" clause_i="1" since=""/>
    <fsummary>Returns the number of connected displays. </fsummary>
    <desc><p>Returns the number of connected displays. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFromPoint" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the index of the display on which the given point lies, or <c>wxNOT_FOUND</c> if the point is not on any connected display. </fsummary>
    <desc><p>Returns the index of the display on which the given point lies, or <c>wxNOT_FOUND</c> if the point is not on any connected display. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFromWindow" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the index of the display on which the given window lies. </fsummary>
    <desc><p>Returns the index of the display on which the given window lies. 
      </p><p>If the window is on more than one display it gets the display that overlaps the window the most.
      </p><p>Returns <c>wxNOT_FOUND</c> if the window is not on any connected display.
      </p></desc>
  </func>
  
  <func>
    <name name="getPPI" arity="1" clause_i="1" since=""/>
    <fsummary>Returns display resolution in pixels per inch. </fsummary>
    <desc><p>Returns display resolution in pixels per inch. 
      </p><p>Horizontal and vertical resolution are returned in <c>x</c> and <c>y</c> components of the {Width,Height} object respectively.
      </p><p>If the resolution information is not available, returns.
      </p><p>Since: 3.1.2 
      </p></desc>
  </func>
  </funcs>
</erlref>
