oracular (3) wxDisplay.3erl.gz

NAME

       wxDisplay - Functions for wxDisplay class

DESCRIPTION

       Determines the sizes and locations of displays connected to the system.

       wxWidgets docs: wxDisplay

DATA TYPES

       wxDisplay() = wx:wx_object()

EXPORTS

       new() -> wxDisplay()

              Default constructor creating wxDisplay object representing the primary display.

       new(Index) -> wxDisplay()

       new(Window) -> wxDisplay()

              Types:

                 Window = wxWindow:wxWindow()

              Constructor creating the display object associated with the given window.

              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.

              See: getFromWindow/1

              Since: 3.1.2

       destroy(This :: wxDisplay()) -> ok

              Destructor.

       isOk(This) -> boolean()

              Types:

                 This = wxDisplay()

              Returns true if the object was initialized successfully.

       getClientArea(This) ->
                        {X :: integer(),
                         Y :: integer(),
                         W :: integer(),
                         H :: integer()}

              Types:

                 This = wxDisplay()

              Returns the client area of the display.

              The  client  area  is  the part of the display available for the normal (non full screen) windows,
              usually it is the same as getGeometry/1 but it could be less if there is a taskbar (or equivalent)
              on this display.

       getGeometry(This) ->
                      {X :: integer(),
                       Y :: integer(),
                       W :: integer(),
                       H :: integer()}

              Types:

                 This = wxDisplay()

              Returns the bounding rectangle of the display whose index was passed to the constructor.

              See: getClientArea/1, wx_misc:displaySize/0

       getName(This) -> unicode:charlist()

              Types:

                 This = wxDisplay()

              Returns the display's name.

              The returned value is currently an empty string under all platforms except MSW.

       isPrimary(This) -> boolean()

              Types:

                 This = wxDisplay()

              Returns true if the display is the primary display.

              The primary display is the one whose index is 0.

       getCount() -> integer()

              Returns the number of connected displays.

       getFromPoint(Pt) -> integer()

              Types:

                 Pt = {X :: integer(), Y :: integer()}

              Returns the index of the display on which the given point lies, or wxNOT_FOUND if the point is not
              on any connected display.

       getFromWindow(Win) -> integer()

              Types:

                 Win = wxWindow:wxWindow()

              Returns the index of the display on which the given window lies.

              If the window is on more than one display it gets the display that overlaps the window the most.

              Returns wxNOT_FOUND if the window is not on any connected display.

       getPPI(This) -> {W :: integer(), H :: integer()}

              Types:

                 This = wxDisplay()

              Returns display resolution in pixels per inch.

              Horizontal and vertical resolution are returned in x and y components of the {Width,Height} object
              respectively.

              If the resolution information is not available, returns.

              Since: 3.1.2