Base Framework
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
WindowImpl Class Reference

Generic window implementation. More...

#include <base/ui/FocuslessWindowImpl.h>

Inherits Object, and Drawable.

Inherited by GraphicsContext, and OpenGLContext.

Classes

class  Key
 
class  Mouse
 
struct  Region
 

Public Types

enum  DisplayMode {
  MODE_WINDOW, MODE_FULL_SCREEN, MODE_WINDOW, MODE_FULL_SCREEN,
  MODE_WINDOW, MODE_FULL_SCREEN
}
 
enum  Cursor {
  INHERIT, NONE, WORKING_IN_BACKGROUND, ARROW,
  CROSSHAIR, HAND, HELP, NO,
  MOVING, NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST,
  WEST_EAST, VERTICAL_ARROW, WAITING, INHERIT,
  NONE, WORKING_IN_BACKGROUND, ARROW, CROSSHAIR,
  HAND, HELP, NO, MOVING,
  NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST,
  VERTICAL_ARROW, WAITING, INHERIT, NONE,
  WORKING_IN_BACKGROUND, ARROW, CROSSHAIR, HAND,
  HELP, NO, MOVING, NORTHEAST_SOUTHWEST,
  NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST, VERTICAL_ARROW,
  WAITING
}
 
enum  Visibility {
  INVISIBLE, OBSCURED, VISIBLE, INVISIBLE,
  OBSCURED, VISIBLE, INVISIBLE, OBSCURED,
  VISIBLE
}
 
enum  Flag {
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1, AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1,
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1
}
 
enum  Focus {
  LOST_FOCUS, ACQUIRED_FOCUS, LOST_FOCUS, ACQUIRED_FOCUS,
  LOST_FOCUS, ACQUIRED_FOCUS
}
 
enum  Binding {
  UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT, MIDDLE_LEFT,
  MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT, LOWER_CENTER,
  LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT,
  MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT,
  LOWER_CENTER, LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER,
  UPPER_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT,
  LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT
}
 
enum  DisplayMode {
  MODE_WINDOW, MODE_FULL_SCREEN, MODE_WINDOW, MODE_FULL_SCREEN,
  MODE_WINDOW, MODE_FULL_SCREEN
}
 
enum  Cursor {
  INHERIT, NONE, WORKING_IN_BACKGROUND, ARROW,
  CROSSHAIR, HAND, HELP, NO,
  MOVING, NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST,
  WEST_EAST, VERTICAL_ARROW, WAITING, INHERIT,
  NONE, WORKING_IN_BACKGROUND, ARROW, CROSSHAIR,
  HAND, HELP, NO, MOVING,
  NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST,
  VERTICAL_ARROW, WAITING, INHERIT, NONE,
  WORKING_IN_BACKGROUND, ARROW, CROSSHAIR, HAND,
  HELP, NO, MOVING, NORTHEAST_SOUTHWEST,
  NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST, VERTICAL_ARROW,
  WAITING
}
 
enum  Visibility {
  INVISIBLE, OBSCURED, VISIBLE, INVISIBLE,
  OBSCURED, VISIBLE, INVISIBLE, OBSCURED,
  VISIBLE
}
 
enum  Flag {
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1, AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1,
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1
}
 
enum  Focus {
  LOST_FOCUS, ACQUIRED_FOCUS, LOST_FOCUS, ACQUIRED_FOCUS,
  LOST_FOCUS, ACQUIRED_FOCUS
}
 
enum  Binding {
  UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT, MIDDLE_LEFT,
  MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT, LOWER_CENTER,
  LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT,
  MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT,
  LOWER_CENTER, LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER,
  UPPER_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT,
  LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT
}
 
enum  DisplayMode {
  MODE_WINDOW, MODE_FULL_SCREEN, MODE_WINDOW, MODE_FULL_SCREEN,
  MODE_WINDOW, MODE_FULL_SCREEN
}
 
enum  Cursor {
  INHERIT, NONE, WORKING_IN_BACKGROUND, ARROW,
  CROSSHAIR, HAND, HELP, NO,
  MOVING, NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST,
  WEST_EAST, VERTICAL_ARROW, WAITING, INHERIT,
  NONE, WORKING_IN_BACKGROUND, ARROW, CROSSHAIR,
  HAND, HELP, NO, MOVING,
  NORTHEAST_SOUTHWEST, NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST,
  VERTICAL_ARROW, WAITING, INHERIT, NONE,
  WORKING_IN_BACKGROUND, ARROW, CROSSHAIR, HAND,
  HELP, NO, MOVING, NORTHEAST_SOUTHWEST,
  NORTH_SOUTH, NORTHWEST_SOUTHEAST, WEST_EAST, VERTICAL_ARROW,
  WAITING
}
 
enum  Visibility {
  INVISIBLE, OBSCURED, VISIBLE, INVISIBLE,
  OBSCURED, VISIBLE, INVISIBLE, OBSCURED,
  VISIBLE
}
 
enum  Flag {
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1, AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1,
  AUTO_CLEAR = 1 << 0, FIXED_SIZE = 1 << 1
}
 
enum  Focus {
  LOST_FOCUS, ACQUIRED_FOCUS, LOST_FOCUS, ACQUIRED_FOCUS,
  LOST_FOCUS, ACQUIRED_FOCUS
}
 
enum  Binding {
  UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT, MIDDLE_LEFT,
  MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT, LOWER_CENTER,
  LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER, UPPER_RIGHT,
  MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, LOWER_LEFT,
  LOWER_CENTER, LOWER_RIGHT, UPPER_LEFT, UPPER_CENTER,
  UPPER_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT,
  LOWER_LEFT, LOWER_CENTER, LOWER_RIGHT
}
 

Public Member Functions

 WindowImpl ()
 
 WindowImpl (const Position &position, const Dimension &dimension, unsigned int flags)
 
Position getBindingOffset (Binding binding) const noexcept
 
void flush ()
 
void invalidate ()
 
String getServerVendor () const
 
unsigned int getServerRelease () const
 
unsigned int getFlags () const
 
void displayMenu (const Position &position, const Menu &menu)
 
bool getAutorepeat () const
 
void setAutorepeat (bool autorepeat)
 
String getTitle () const
 
void setTitle (const String &title)
 
String getIconTitle () const
 
void setIconTitle (const String &title)
 
Position getPosition () const
 
void setPosition (const Position &position)
 
Dimension getDimension () const
 
void setDimension (const Dimension &dimension)
 
void setRegion (const Position &position, const Dimension &dimension)
 
void setMinimumSize (const Dimension &dimension)
 
void setMaximumSize (const Dimension &dimension)
 
Cursor getCursor () const noexcept
 
void setCursor (Cursor cursor)
 
Position toGlobalPosition (const Position &position) const
 
Position getCursorPosition () const
 
void setCursorPosition (const Position &position)
 
void releaseCursorConfinement ()
 
void setCursorConfinement ()
 
void setCursorConfinement (const Position &position, const Dimension &dimension)
 
void disableClipping ()
 
Region getClipping () const
 
void setClipping (const Position &position, const Dimension &dimension)
 
void close ()
 
bool isChildOf (const WindowImpl &object)
 
bool isParentOf (const WindowImpl &object)
 
bool isMaximized ()
 
bool isMinimized ()
 
void maximize ()
 
void minimize ()
 
void normalize ()
 
bool isVisible () const noexcept
 
Visibility getVisibility () const noexcept
 
void show ()
 
void hide ()
 
bool isEnabled () const noexcept
 
void enable ()
 
void disable ()
 
void raise ()
 
void acquireFocus ()
 
bool getCapture () const
 
void setCapture (bool state)
 
DisplayMode getDisplayMode () const
 
void setDisplayMode (DisplayMode displayMode)
 
unsigned int getKeyState (unsigned int code) const
 
unsigned int getModifiers () const
 
virtual void onDestruction () noexcept
 
virtual void onDisplay () noexcept
 
virtual void onMove (const Position &position) noexcept
 
virtual void onResize (const Dimension &dimension) noexcept
 
virtual void onMouseMove (const Position &position, unsigned int buttons) noexcept
 
virtual void onMouseScope (bool scope) noexcept
 
virtual void onMouseButton (const Position &position, Mouse::Button button, Mouse::Event event, unsigned int state) noexcept
 
virtual void onMouseWheel (const Position &position, int delta, unsigned int buttons) noexcept
 
virtual void onKey (unsigned int key, unsigned int flags, unsigned int modifiers) noexcept
 
virtual void onIdle () noexcept
 
virtual bool onClose () noexcept
 
virtual void onVisibility (Visibility visibility) noexcept
 
virtual void onFocus (Focus focus) noexcept
 
virtual void onMenu (unsigned int identifier) noexcept
 
virtual void onCommand (unsigned int identifier) noexcept
 
void update ()
 
void wait ()
 
bool wait (unsigned int milliseconds)
 
bool openDispatch ()
 
bool hasMouse () noexcept
 
unsigned int getMouseButtons () noexcept
 
unsigned int getNumberOfMonitors () noexcept
 
Dimension getDisplayDimension () noexcept
 
bool isResponding (unsigned int milliseconds)
 
virtual ~WindowImpl () noexcept
 
 WindowImpl ()
 
 WindowImpl (const Position &position, const Dimension &dimension, unsigned int flags)
 
Position getBindingOffset (Binding binding) const noexcept
 
void flush ()
 
void invalidate ()
 
String getServerVendor () const
 
unsigned int getServerRelease () const
 
unsigned int getFlags () const
 
void displayMenu (const Position &position, const Menu &menu)
 
bool getAutorepeat () const
 
void setAutorepeat (bool autorepeat)
 
String getTitle () const
 
void setTitle (const String &title)
 
String getIconTitle () const
 
void setIconTitle (const String &title)
 
Position getPosition () const
 
void setPosition (const Position &position)
 
Dimension getDimension () const
 
void setDimension (const Dimension &dimension)
 
void setRegion (const Position &position, const Dimension &dimension)
 
void setMinimumSize (const Dimension &dimension)
 
void setMaximumSize (const Dimension &dimension)
 
Cursor getCursor () const noexcept
 
void setCursor (Cursor cursor)
 
Position toGlobalPosition (const Position &position) const
 
Position getCursorPosition () const
 
void setCursorPosition (const Position &position)
 
void releaseCursorConfinement ()
 
void setCursorConfinement ()
 
void setCursorConfinement (const Position &position, const Dimension &dimension)
 
void disableClipping ()
 
Region getClipping () const
 
void setClipping (const Position &position, const Dimension &dimension)
 
void close ()
 
bool isChildOf (const WindowImpl &object)
 
bool isParentOf (const WindowImpl &object)
 
bool isMaximized ()
 
bool isMinimized ()
 
void maximize ()
 
void minimize ()
 
void normalize ()
 
bool isVisible () const noexcept
 
Visibility getVisibility () const noexcept
 
void show ()
 
void hide ()
 
bool isEnabled () const noexcept
 
void enable ()
 
void disable ()
 
void raise ()
 
void acquireFocus ()
 
bool getCapture () const
 
void setCapture (bool state)
 
DisplayMode getDisplayMode () const
 
void setDisplayMode (DisplayMode displayMode)
 
unsigned int getKeyState (unsigned int code) const
 
unsigned int getModifiers () const
 
virtual void onDestruction () noexcept
 
virtual void onDisplay () noexcept
 
virtual void onMove (const Position &position) noexcept
 
virtual void onResize (const Dimension &dimension) noexcept
 
virtual void onMouseMove (const Position &position, unsigned int buttons) noexcept
 
virtual void onMouseScope (bool scope) noexcept
 
virtual void onMouseButton (const Position &position, Mouse::Button button, Mouse::Event event, unsigned int state) noexcept
 
virtual void onMouseWheel (const Position &position, int delta, unsigned int buttons) noexcept
 
virtual void onKey (unsigned int key, unsigned int flags, unsigned int modifiers) noexcept
 
virtual void onIdle () noexcept
 
virtual bool onClose () noexcept
 
virtual void onVisibility (Visibility visibility) noexcept
 
virtual void onFocus (Focus focus) noexcept
 
virtual void onMenu (unsigned int identifier) noexcept
 
virtual void onCommand (unsigned int identifier) noexcept
 
void update ()
 
void wait ()
 
bool wait (unsigned int milliseconds)
 
bool openDispatch ()
 
bool hasMouse () noexcept
 
unsigned int getMouseButtons () noexcept
 
unsigned int getNumberOfMonitors () noexcept
 
Dimension getDisplayDimension () noexcept
 
bool isResponding (unsigned int milliseconds)
 
virtual ~WindowImpl () noexcept
 
 WindowImpl ()
 
 WindowImpl (const Position &position, const Dimension &dimension, unsigned int flags)
 
Position getLocalBindingOffset (Binding binding) const noexcept
 
Position getBindingOffset (Binding binding) const noexcept
 
void flush ()
 
void invalidate ()
 
String getServerVendor () const
 
unsigned int getServerRelease () const
 
unsigned int getFlags () const
 
void displayMenu (const Position &position, const Menu &menu)
 
bool getAutorepeat () const
 
void setAutorepeat (bool autorepeat)
 
String getTitle () const
 
void setTitle (const String &title)
 
String getIconTitle () const
 
void setIconTitle (const String &title)
 
Position getPosition () const
 
void setPosition (const Position &position)
 
Dimension getDimension () const
 
void setDimension (const Dimension &dimension)
 
void setRegion (const Position &position, const Dimension &dimension)
 
void setMinimumSize (const Dimension &dimension)
 
void setMaximumSize (const Dimension &dimension)
 
Cursor getCursor () const noexcept
 
void setCursor (Cursor cursor)
 
Position toGlobalPosition (const Position &position) const
 
Position getCursorPosition () const
 
void setCursorPosition (const Position &position)
 
void releaseCursorConfinement ()
 
void setCursorConfinement ()
 
void setCursorConfinement (const Position &position, const Dimension &dimension)
 
void disableClipping ()
 
Region getClipping () const
 
void setClipping (const Position &position, const Dimension &dimension)
 
void close ()
 
bool isChildOf (const WindowImpl &object)
 
bool isParentOf (const WindowImpl &object)
 
bool isMaximized ()
 
bool isMinimized ()
 
void maximize ()
 
void minimize ()
 
void normalize ()
 
bool isVisible () const noexcept
 
Visibility getVisibility () const noexcept
 
void show ()
 
void hide ()
 
bool isEnabled () const noexcept
 
void enable ()
 
void disable ()
 
void raise ()
 
void acquireFocus ()
 
bool getCapture () const
 
void setCapture (bool state)
 
DisplayMode getDisplayMode () const
 
void setDisplayMode (DisplayMode displayMode)
 
unsigned int getKeyState (unsigned int code) const
 
unsigned int getModifiers () const
 
virtual void onDestruction () noexcept
 
virtual void onDisplay () noexcept
 
virtual void onMove (const Position &position) noexcept
 
virtual void onResize (const Dimension &dimension) noexcept
 
virtual void onMouseMove (const Position &position, unsigned int buttons) noexcept
 
virtual void onMouseScope (bool scope) noexcept
 
virtual void onMouseButton (const Position &position, Mouse::Button button, Mouse::Event event, unsigned int state) noexcept
 
virtual void onMouseWheel (const Position &position, int delta, unsigned int buttons) noexcept
 
virtual void onKey (unsigned int key, unsigned int flags, unsigned int modifiers) noexcept
 
virtual void onIdle () noexcept
 
virtual bool onClose () noexcept
 
virtual void onVisibility (Visibility visibility) noexcept
 
virtual void onFocus (Focus focus) noexcept
 
virtual void onMenu (unsigned int identifier) noexcept
 
virtual void onCommand (unsigned int identifier) noexcept
 
void update ()
 
void wait ()
 
bool wait (unsigned int milliseconds)
 
bool openDispatch ()
 
bool hasMouse () noexcept
 
unsigned int getMouseButtons () noexcept
 
unsigned int getNumberOfMonitors () noexcept
 
Dimension getDisplayDimension () noexcept
 
bool isResponding (unsigned int milliseconds)
 
virtual ~WindowImpl () noexcept
 

Static Public Member Functions

static unsigned int getMouseButtonIndex (Mouse::Button button) noexcept
 
static Literal getMouseButtonName (Mouse::Button button) noexcept
 
static void exit () noexcept
 
static void dispatch ()
 
static unsigned int getMouseButtonIndex (Mouse::Button button) noexcept
 
static Literal getMouseButtonName (Mouse::Button button) noexcept
 
static void exit () noexcept
 
static void dispatch ()
 
static unsigned int getMouseButtonIndex (Mouse::Button button) noexcept
 
static Literal getMouseButtonName (Mouse::Button button) noexcept
 
static void exit () noexcept
 
static void dispatch ()
 

Protected Member Functions

void construct () noexcept
 
virtual void destroy () noexcept
 
void construct () noexcept
 
virtual void destroy () noexcept
 
void construct () noexcept
 
virtual void destroy () noexcept
 

Protected Attributes

String title
 
String iconTitle
 
Position position
 
Dimension dimension
 
unsigned int flags = 0
 
Dimension minimumSize
 
Dimension maximumSize
 
void * screenHandle = nullptr
 
void * graphicsContextHandle = nullptr
 
- Protected Attributes inherited from Drawable
void * drawableHandle = nullptr
 

Static Protected Attributes

static void * displayHandle
 

Detailed Description

Generic window implementation.

Generic window implementation. This class cannot be instantiated.

Version
1.0

Member Enumeration Documentation

◆ Binding [1/3]

Enumerator
UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

◆ Binding [2/3]

Enumerator
UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

◆ Binding [3/3]

Enumerator
UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

UPPER_LEFT 

Upper left corner.

UPPER_CENTER 

Upper center.

UPPER_RIGHT 

Upper rigth corner.

MIDDLE_LEFT 

Middle to the left.

MIDDLE_CENTER 

Middle at the center.

MIDDLE_RIGHT 

Middle to the right .

LOWER_LEFT 

Lower left corner.

LOWER_CENTER 

Lower center.

LOWER_RIGHT 

Lower right corner.

◆ Cursor [1/3]

The cursors.

Enumerator
INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

◆ Cursor [2/3]

The cursors.

Enumerator
INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

◆ Cursor [3/3]

The cursors.

Enumerator
INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

INHERIT 

Inherit cursor.

NONE 

No cursor.

WORKING_IN_BACKGROUND 

Cursor indicating working is being the background.

ARROW 

The normal selection cursor.

CROSSHAIR 

Cross hair.

HAND 

Hand.

HELP 

Help.

NO 

No.

MOVING 

Moving.

NORTHEAST_SOUTHWEST 

Northeast and southwest pointing arrow.

NORTH_SOUTH 

A birectional arrow.

NORTHWEST_SOUTHEAST 

Northwest and southeast pointing arrow.

WEST_EAST 

A birectional arrow pointer in the west and east direction.

VERTICAL_ARROW 

A vertical arrow.

WAITING 

Cursor indicating blocked wait.

◆ DisplayMode [1/3]

Display modes.

Enumerator
MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

◆ DisplayMode [2/3]

Display modes.

Enumerator
MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

◆ DisplayMode [3/3]

Display modes.

Enumerator
MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

MODE_WINDOW 

Window mode.

MODE_FULL_SCREEN 

Full screen mode.

◆ Flag [1/3]

Window flags.

Enumerator
AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

◆ Flag [2/3]

Window flags.

Enumerator
AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

◆ Flag [3/3]

Window flags.

Enumerator
AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

AUTO_CLEAR 

Specifies that the window should be cleared automatically.

FIXED_SIZE 

Specifies that the window cannot be resized.

◆ Focus [1/3]

Focus state.

◆ Focus [2/3]

Focus state.

◆ Focus [3/3]

Focus state.

◆ Visibility [1/3]

Visibility state.

Enumerator
INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

◆ Visibility [2/3]

Visibility state.

Enumerator
INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

◆ Visibility [3/3]

Visibility state.

Enumerator
INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

INVISIBLE 

The window is invisible.

OBSCURED 

The window is partially visible.

VISIBLE 

The window is fully visible.

Constructor & Destructor Documentation

◆ WindowImpl() [1/6]

WindowImpl::WindowImpl ( )

Initializes a new window with position (0, 0) and dimension (0, 0).

◆ WindowImpl() [2/6]

WindowImpl::WindowImpl ( const Position position,
const Dimension dimension,
unsigned int  flags 
)

Initializes a new window.

◆ ~WindowImpl() [1/3]

virtual WindowImpl::~WindowImpl ( )
virtualnoexcept

Releases the window.

◆ WindowImpl() [3/6]

WindowImpl::WindowImpl ( )

Initializes a new window with position (0, 0) and dimension (0, 0).

◆ WindowImpl() [4/6]

WindowImpl::WindowImpl ( const Position position,
const Dimension dimension,
unsigned int  flags 
)

Initializes a new window.

◆ ~WindowImpl() [2/3]

virtual WindowImpl::~WindowImpl ( )
virtualnoexcept

Releases the window.

◆ WindowImpl() [5/6]

WindowImpl::WindowImpl ( )

Initializes a new window with position (0, 0) and dimension (0, 0).

◆ WindowImpl() [6/6]

WindowImpl::WindowImpl ( const Position position,
const Dimension dimension,
unsigned int  flags 
)

Initializes a new window.

◆ ~WindowImpl() [3/3]

virtual WindowImpl::~WindowImpl ( )
virtualnoexcept

Releases the window.

Member Function Documentation

◆ acquireFocus() [1/3]

void WindowImpl::acquireFocus ( )

Acquire focus for this window.

◆ acquireFocus() [2/3]

void WindowImpl::acquireFocus ( )

Acquire focus for this window.

◆ acquireFocus() [3/3]

void WindowImpl::acquireFocus ( )

Acquire focus for this window.

◆ close() [1/3]

void WindowImpl::close ( )

Closes the window.

◆ close() [2/3]

void WindowImpl::close ( )

Closes the window.

◆ close() [3/3]

void WindowImpl::close ( )

Closes the window.

◆ construct() [1/3]

void WindowImpl::construct ( )
protectednoexcept

Invoked after initial context specific initialization to finalize the generic initialization.

◆ construct() [2/3]

void WindowImpl::construct ( )
protectednoexcept

Invoked after initial context specific initialization to finalize the generic initialization.

◆ construct() [3/3]

void WindowImpl::construct ( )
protectednoexcept

Invoked after initial context specific initialization to finalize the generic initialization.

◆ destroy() [1/3]

virtual void WindowImpl::destroy ( )
protectedvirtualnoexcept

Invoked when the window is destroyed.

◆ destroy() [2/3]

virtual void WindowImpl::destroy ( )
protectedvirtualnoexcept

Invoked when the window is destroyed.

◆ destroy() [3/3]

virtual void WindowImpl::destroy ( )
protectedvirtualnoexcept

Invoked when the window is destroyed.

◆ disable() [1/3]

void WindowImpl::disable ( )

Disable the window.

◆ disable() [2/3]

void WindowImpl::disable ( )

Disable the window.

◆ disable() [3/3]

void WindowImpl::disable ( )

Disable the window.

◆ disableClipping() [1/3]

void WindowImpl::disableClipping ( )

Disable clipping.

◆ disableClipping() [2/3]

void WindowImpl::disableClipping ( )

Disable clipping.

◆ disableClipping() [3/3]

void WindowImpl::disableClipping ( )

Disable clipping.

◆ dispatch() [1/3]

static void WindowImpl::dispatch ( )
static

This method is responsible for dispatching incoming messages to the corresponding message handlers.

◆ dispatch() [2/3]

static void WindowImpl::dispatch ( )
static

This method is responsible for dispatching incoming messages to the corresponding message handlers.

◆ dispatch() [3/3]

static void WindowImpl::dispatch ( )
static

This method is responsible for dispatching incoming messages to the corresponding message handlers.

◆ displayMenu() [1/3]

void WindowImpl::displayMenu ( const Position position,
const Menu menu 
)

Displays the specified menu at the specified position.

Parameters
positionThe position.
menuThe menu.

◆ displayMenu() [2/3]

void WindowImpl::displayMenu ( const Position position,
const Menu menu 
)

Displays the specified menu at the specified position.

Parameters
positionThe position.
menuThe menu.

◆ displayMenu() [3/3]

void WindowImpl::displayMenu ( const Position position,
const Menu menu 
)

Displays the specified menu at the specified position.

Parameters
positionThe position.
menuThe menu.

◆ enable() [1/3]

void WindowImpl::enable ( )

Enables the window.

◆ enable() [2/3]

void WindowImpl::enable ( )

Enables the window.

◆ enable() [3/3]

void WindowImpl::enable ( )

Enables the window.

◆ exit() [1/3]

static void WindowImpl::exit ( )
staticnoexcept

Exit message dispatcher without asking the application to exit.

◆ exit() [2/3]

static void WindowImpl::exit ( )
staticnoexcept

Exit message dispatcher without asking the application to exit.

◆ exit() [3/3]

static void WindowImpl::exit ( )
staticnoexcept

Exit message dispatcher without asking the application to exit.

◆ flush() [1/3]

void WindowImpl::flush ( )
inline

Flushes the window requests to the server.

◆ flush() [2/3]

void WindowImpl::flush ( )
inline

Flushes the window requests to the server.

◆ flush() [3/3]

void WindowImpl::flush ( )
inline

Flushes the window requests to the server.

◆ getAutorepeat() [1/3]

bool WindowImpl::getAutorepeat ( ) const
inline

Returns the autorepeat.

◆ getAutorepeat() [2/3]

bool WindowImpl::getAutorepeat ( ) const
inline

Returns the autorepeat.

◆ getAutorepeat() [3/3]

bool WindowImpl::getAutorepeat ( ) const
inline

Returns the autorepeat.

◆ getBindingOffset() [1/3]

Position WindowImpl::getBindingOffset ( Binding  binding) const
noexcept

Returns the position of the binding point relative to the owner.

◆ getBindingOffset() [2/3]

Position WindowImpl::getBindingOffset ( Binding  binding) const
noexcept

Returns the position of the binding point relative to the owner.

◆ getBindingOffset() [3/3]

Position WindowImpl::getBindingOffset ( Binding  binding) const
noexcept

Returns the position of the binding point relative to the owner.

◆ getCapture() [1/3]

bool WindowImpl::getCapture ( ) const

Returns the mouse capture state of the window.

◆ getCapture() [2/3]

bool WindowImpl::getCapture ( ) const

Returns the mouse capture state of the window.

◆ getCapture() [3/3]

bool WindowImpl::getCapture ( ) const

Returns the mouse capture state of the window.

◆ getClipping() [1/3]

Region WindowImpl::getClipping ( ) const

Returns the clipping region.

◆ getClipping() [2/3]

Region WindowImpl::getClipping ( ) const

Returns the clipping region.

◆ getClipping() [3/3]

Region WindowImpl::getClipping ( ) const

Returns the clipping region.

◆ getCursor() [1/3]

Cursor WindowImpl::getCursor ( ) const
inlinenoexcept

Returns the current mouse cursor for the window.

◆ getCursor() [2/3]

Cursor WindowImpl::getCursor ( ) const
inlinenoexcept

Returns the current mouse cursor for the window.

◆ getCursor() [3/3]

Cursor WindowImpl::getCursor ( ) const
inlinenoexcept

Returns the current mouse cursor for the window.

◆ getCursorPosition() [1/3]

Position WindowImpl::getCursorPosition ( ) const

Returns the mouse position.

◆ getCursorPosition() [2/3]

Position WindowImpl::getCursorPosition ( ) const

Returns the mouse position.

◆ getCursorPosition() [3/3]

Position WindowImpl::getCursorPosition ( ) const

Returns the mouse position.

◆ getDimension() [1/3]

Dimension WindowImpl::getDimension ( ) const
inline

Returns the size of the window.

◆ getDimension() [2/3]

Dimension WindowImpl::getDimension ( ) const
inline

Returns the size of the window.

◆ getDimension() [3/3]

Dimension WindowImpl::getDimension ( ) const
inline

Returns the size of the window.

◆ getDisplayDimension() [1/3]

Dimension WindowImpl::getDisplayDimension ( )
noexcept

Returns the dimension of the display.

◆ getDisplayDimension() [2/3]

Dimension WindowImpl::getDisplayDimension ( )
noexcept

Returns the dimension of the display.

◆ getDisplayDimension() [3/3]

Dimension WindowImpl::getDisplayDimension ( )
noexcept

Returns the dimension of the display.

◆ getDisplayMode() [1/3]

DisplayMode WindowImpl::getDisplayMode ( ) const
inline

Returns the display mode.

◆ getDisplayMode() [2/3]

DisplayMode WindowImpl::getDisplayMode ( ) const
inline

Returns the display mode.

◆ getDisplayMode() [3/3]

DisplayMode WindowImpl::getDisplayMode ( ) const
inline

Returns the display mode.

◆ getFlags() [1/3]

unsigned int WindowImpl::getFlags ( ) const
inline

Returns the window flags.

◆ getFlags() [2/3]

unsigned int WindowImpl::getFlags ( ) const
inline

Returns the window flags.

◆ getFlags() [3/3]

unsigned int WindowImpl::getFlags ( ) const
inline

Returns the window flags.

◆ getIconTitle() [1/3]

String WindowImpl::getIconTitle ( ) const

Returns the icon title.

◆ getIconTitle() [2/3]

String WindowImpl::getIconTitle ( ) const

Returns the icon title.

◆ getIconTitle() [3/3]

String WindowImpl::getIconTitle ( ) const

Returns the icon title.

◆ getKeyState() [1/3]

unsigned int WindowImpl::getKeyState ( unsigned int  code) const

Returns the state of the specified key.

◆ getKeyState() [2/3]

unsigned int WindowImpl::getKeyState ( unsigned int  code) const

Returns the state of the specified key.

◆ getKeyState() [3/3]

unsigned int WindowImpl::getKeyState ( unsigned int  code) const

Returns the state of the specified key.

◆ getLocalBindingOffset()

Position WindowImpl::getLocalBindingOffset ( Binding  binding) const
inlinenoexcept

Returns the position of the binding point relative to this window.

◆ getModifiers() [1/3]

unsigned int WindowImpl::getModifiers ( ) const
inline

Returns the keyboard modifiers.

◆ getModifiers() [2/3]

unsigned int WindowImpl::getModifiers ( ) const
inline

Returns the keyboard modifiers.

◆ getModifiers() [3/3]

unsigned int WindowImpl::getModifiers ( ) const
inline

Returns the keyboard modifiers.

◆ getMouseButtonIndex() [1/3]

static unsigned int WindowImpl::getMouseButtonIndex ( Mouse::Button  button)
staticnoexcept

Returns the zero-based index of the specified mouse button.

◆ getMouseButtonIndex() [2/3]

static unsigned int WindowImpl::getMouseButtonIndex ( Mouse::Button  button)
staticnoexcept

Returns the zero-based index of the specified mouse button.

◆ getMouseButtonIndex() [3/3]

static unsigned int WindowImpl::getMouseButtonIndex ( Mouse::Button  button)
staticnoexcept

Returns the zero-based index of the specified mouse button.

◆ getMouseButtonName() [1/3]

static Literal WindowImpl::getMouseButtonName ( Mouse::Button  button)
staticnoexcept

Returns the name of the specified mouse button.

◆ getMouseButtonName() [2/3]

static Literal WindowImpl::getMouseButtonName ( Mouse::Button  button)
staticnoexcept

Returns the name of the specified mouse button.

◆ getMouseButtonName() [3/3]

static Literal WindowImpl::getMouseButtonName ( Mouse::Button  button)
staticnoexcept

Returns the name of the specified mouse button.

◆ getMouseButtons() [1/3]

unsigned int WindowImpl::getMouseButtons ( )
noexcept

Returns the available mouse buttons.

◆ getMouseButtons() [2/3]

unsigned int WindowImpl::getMouseButtons ( )
noexcept

Returns the available mouse buttons.

◆ getMouseButtons() [3/3]

unsigned int WindowImpl::getMouseButtons ( )
noexcept

Returns the available mouse buttons.

◆ getNumberOfMonitors() [1/3]

unsigned int WindowImpl::getNumberOfMonitors ( )
noexcept

Returns the number of monitors.

◆ getNumberOfMonitors() [2/3]

unsigned int WindowImpl::getNumberOfMonitors ( )
noexcept

Returns the number of monitors.

◆ getNumberOfMonitors() [3/3]

unsigned int WindowImpl::getNumberOfMonitors ( )
noexcept

Returns the number of monitors.

◆ getPosition() [1/3]

Position WindowImpl::getPosition ( ) const
inline

Returns the current position of the window.

◆ getPosition() [2/3]

Position WindowImpl::getPosition ( ) const
inline

Returns the current position of the window.

◆ getPosition() [3/3]

Position WindowImpl::getPosition ( ) const
inline

Returns the current position of the window.

◆ getServerRelease() [1/3]

unsigned int WindowImpl::getServerRelease ( ) const

Returns the release of the server.

◆ getServerRelease() [2/3]

unsigned int WindowImpl::getServerRelease ( ) const

Returns the release of the server.

◆ getServerRelease() [3/3]

unsigned int WindowImpl::getServerRelease ( ) const

Returns the release of the server.

◆ getServerVendor() [1/3]

String WindowImpl::getServerVendor ( ) const

Returns the vendor of the server.

◆ getServerVendor() [2/3]

String WindowImpl::getServerVendor ( ) const

Returns the vendor of the server.

◆ getServerVendor() [3/3]

String WindowImpl::getServerVendor ( ) const

Returns the vendor of the server.

◆ getTitle() [1/3]

String WindowImpl::getTitle ( ) const

Returns the current title of the window.

◆ getTitle() [2/3]

String WindowImpl::getTitle ( ) const

Returns the current title of the window.

◆ getTitle() [3/3]

String WindowImpl::getTitle ( ) const

Returns the current title of the window.

◆ hasMouse() [1/3]

bool WindowImpl::hasMouse ( )
noexcept

Returns true if a mouse is present.

◆ hasMouse() [2/3]

bool WindowImpl::hasMouse ( )
noexcept

Returns true if a mouse is present.

◆ hasMouse() [3/3]

bool WindowImpl::hasMouse ( )
noexcept

Returns true if a mouse is present.

◆ hide() [1/3]

void WindowImpl::hide ( )

Hides the window.

◆ hide() [2/3]

void WindowImpl::hide ( )

Hides the window.

◆ hide() [3/3]

void WindowImpl::hide ( )

Hides the window.

◆ invalidate() [1/3]

void WindowImpl::invalidate ( )

Asynchronous update request.

◆ invalidate() [2/3]

void WindowImpl::invalidate ( )

Asynchronous update request.

◆ invalidate() [3/3]

void WindowImpl::invalidate ( )

Asynchronous update request.

◆ isChildOf() [1/3]

bool WindowImpl::isChildOf ( const WindowImpl object)

Returns true if this object is a child of the specified object.

◆ isChildOf() [2/3]

bool WindowImpl::isChildOf ( const WindowImpl object)

Returns true if this object is a child of the specified object.

◆ isChildOf() [3/3]

bool WindowImpl::isChildOf ( const WindowImpl object)

Returns true if this object is a child of the specified object.

◆ isEnabled() [1/3]

bool WindowImpl::isEnabled ( ) const
inlinenoexcept

Returns true if the window is enabled.

◆ isEnabled() [2/3]

bool WindowImpl::isEnabled ( ) const
inlinenoexcept

Returns true if the window is enabled.

◆ isEnabled() [3/3]

bool WindowImpl::isEnabled ( ) const
inlinenoexcept

Returns true if the window is enabled.

◆ isMaximized() [1/3]

bool WindowImpl::isMaximized ( )

Returns true if the window is maximized.

◆ isMaximized() [2/3]

bool WindowImpl::isMaximized ( )

Returns true if the window is maximized.

◆ isMaximized() [3/3]

bool WindowImpl::isMaximized ( )

Returns true if the window is maximized.

◆ isMinimized() [1/3]

bool WindowImpl::isMinimized ( )

Returns true if the window is minimized.

◆ isMinimized() [2/3]

bool WindowImpl::isMinimized ( )

Returns true if the window is minimized.

◆ isMinimized() [3/3]

bool WindowImpl::isMinimized ( )

Returns true if the window is minimized.

◆ isParentOf() [1/3]

bool WindowImpl::isParentOf ( const WindowImpl object)

Returns true if this object is the parent of the specified object.

◆ isParentOf() [2/3]

bool WindowImpl::isParentOf ( const WindowImpl object)

Returns true if this object is the parent of the specified object.

◆ isParentOf() [3/3]

bool WindowImpl::isParentOf ( const WindowImpl object)

Returns true if this object is the parent of the specified object.

◆ isResponding() [1/3]

bool WindowImpl::isResponding ( unsigned int  milliseconds)

Returns true if the window is reponsing within the specified timeout period.

Parameters
millisecondsThe timeout period (silently reduced to 999999999).

◆ isResponding() [2/3]

bool WindowImpl::isResponding ( unsigned int  milliseconds)

Returns true if the window is reponsing within the specified timeout period.

Parameters
millisecondsThe timeout period (silently reduced to 999999999).

◆ isResponding() [3/3]

bool WindowImpl::isResponding ( unsigned int  milliseconds)

Returns true if the window is reponsing within the specified timeout period.

Parameters
millisecondsThe timeout period (silently reduced to 999999999).

◆ isVisible() [1/3]

bool WindowImpl::isVisible ( ) const
inlinenoexcept

Returns true if the window is visible.

◆ isVisible() [2/3]

bool WindowImpl::isVisible ( ) const
inlinenoexcept

Returns true if the window is visible.

◆ isVisible() [3/3]

bool WindowImpl::isVisible ( ) const
inlinenoexcept

Returns true if the window is visible.

◆ maximize() [1/3]

void WindowImpl::maximize ( )

Maximizes the window.

◆ maximize() [2/3]

void WindowImpl::maximize ( )

Maximizes the window.

◆ maximize() [3/3]

void WindowImpl::maximize ( )

Maximizes the window.

◆ minimize() [1/3]

void WindowImpl::minimize ( )

Minimizes the window.

◆ minimize() [2/3]

void WindowImpl::minimize ( )

Minimizes the window.

◆ minimize() [3/3]

void WindowImpl::minimize ( )

Minimizes the window.

◆ normalize() [1/3]

void WindowImpl::normalize ( )

Restores the original position and dimension of the window if currently minimized or maximized.

◆ normalize() [2/3]

void WindowImpl::normalize ( )

Restores the original position and dimension of the window if currently minimized or maximized.

◆ normalize() [3/3]

void WindowImpl::normalize ( )

Restores the original position and dimension of the window if currently minimized or maximized.

◆ onClose() [1/3]

virtual bool WindowImpl::onClose ( )
virtualnoexcept

Invoked when the window is asked to be closed. This method must return true if the window may be closed. The default implementation returns true and also asks the application to exit.

◆ onClose() [2/3]

virtual bool WindowImpl::onClose ( )
virtualnoexcept

Invoked when the window is asked to be closed. This method must return true if the window may be closed. The default implementation returns true and also asks the application to exit.

◆ onClose() [3/3]

virtual bool WindowImpl::onClose ( )
virtualnoexcept

Invoked when the window is asked to be closed. This method must return true if the window may be closed. The default implementation returns true and also asks the application to exit.

◆ onCommand() [1/3]

virtual void WindowImpl::onCommand ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send to the window.

◆ onCommand() [2/3]

virtual void WindowImpl::onCommand ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send to the window.

◆ onCommand() [3/3]

virtual void WindowImpl::onCommand ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send to the window.

◆ onDestruction() [1/3]

virtual void WindowImpl::onDestruction ( )
virtualnoexcept

Invoked when the window is destroyed.

◆ onDestruction() [2/3]

virtual void WindowImpl::onDestruction ( )
virtualnoexcept

Invoked when the window is destroyed.

◆ onDestruction() [3/3]

virtual void WindowImpl::onDestruction ( )
virtualnoexcept

Invoked when the window is destroyed.

◆ onDisplay() [1/3]

virtual void WindowImpl::onDisplay ( )
virtualnoexcept

Invoked when the display should be updated.

Reimplemented in Button, Split, Label, Picture, Button, ProgressBar, Button, OpenGLContext, Slider, and OpenGLWidget.

◆ onDisplay() [2/3]

virtual void WindowImpl::onDisplay ( )
virtualnoexcept

Invoked when the display should be updated.

Reimplemented in Button, Split, Label, Picture, Button, ProgressBar, Button, OpenGLContext, Slider, and OpenGLWidget.

◆ onDisplay() [3/3]

virtual void WindowImpl::onDisplay ( )
virtualnoexcept

Invoked when the display should be updated.

Reimplemented in Button, Split, Label, Picture, Button, ProgressBar, Button, OpenGLContext, Slider, and OpenGLWidget.

◆ onFocus() [1/3]

virtual void WindowImpl::onFocus ( Focus  focus)
virtualnoexcept

Invoked when the focus state changes.

◆ onFocus() [2/3]

virtual void WindowImpl::onFocus ( Focus  focus)
virtualnoexcept

Invoked when the focus state changes.

◆ onFocus() [3/3]

virtual void WindowImpl::onFocus ( Focus  focus)
virtualnoexcept

Invoked when the focus state changes.

◆ onIdle() [1/3]

virtual void WindowImpl::onIdle ( )
virtualnoexcept

Invoked continuously when no messages have been queued. The default implementation waits for an incoming message.

◆ onIdle() [2/3]

virtual void WindowImpl::onIdle ( )
virtualnoexcept

Invoked continuously when no messages have been queued. The default implementation waits for an incoming message.

◆ onIdle() [3/3]

virtual void WindowImpl::onIdle ( )
virtualnoexcept

Invoked continuously when no messages have been queued. The default implementation waits for an incoming message.

◆ onKey() [1/3]

virtual void WindowImpl::onKey ( unsigned int  key,
unsigned int  flags,
unsigned int  modifiers 
)
virtualnoexcept

Invoked when a key is pressed or released.

Parameters
keyThe key.
flagsFlags describing the key event.
modifiersThe current state of the key modifiers (e.g. SHIFT).

Reimplemented in Button, Split, Button, Button, and Slider.

◆ onKey() [2/3]

virtual void WindowImpl::onKey ( unsigned int  key,
unsigned int  flags,
unsigned int  modifiers 
)
virtualnoexcept

Invoked when a key is pressed or released.

Parameters
keyThe key.
flagsFlags describing the key event.
modifiersThe current state of the key modifiers (e.g. SHIFT).

Reimplemented in Button, Split, Button, Button, and Slider.

◆ onKey() [3/3]

virtual void WindowImpl::onKey ( unsigned int  key,
unsigned int  flags,
unsigned int  modifiers 
)
virtualnoexcept

Invoked when a key is pressed or released.

Parameters
keyThe key.
flagsFlags describing the key event.
modifiersThe current state of the key modifiers (e.g. SHIFT).

Reimplemented in Button, Split, Button, Button, and Slider.

◆ onMenu() [1/3]

virtual void WindowImpl::onMenu ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send from a menu to the window.

◆ onMenu() [2/3]

virtual void WindowImpl::onMenu ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send from a menu to the window.

◆ onMenu() [3/3]

virtual void WindowImpl::onMenu ( unsigned int  identifier)
virtualnoexcept

Invoked when a command is send from a menu to the window.

◆ onMouseButton() [1/3]

virtual void WindowImpl::onMouseButton ( const Position position,
Mouse::Button  button,
Mouse::Event  event,
unsigned int  state 
)
virtualnoexcept

Invoked when the mouse button state changes.

Parameters
positionThe position of the mouse.
buttonThe button that changed state.
eventThe mouse button event.

◆ onMouseButton() [2/3]

virtual void WindowImpl::onMouseButton ( const Position position,
Mouse::Button  button,
Mouse::Event  event,
unsigned int  state 
)
virtualnoexcept

Invoked when the mouse button state changes.

Parameters
positionThe position of the mouse.
buttonThe button that changed state.
eventThe mouse button event.

◆ onMouseButton() [3/3]

virtual void WindowImpl::onMouseButton ( const Position position,
Mouse::Button  button,
Mouse::Event  event,
unsigned int  state 
)
virtualnoexcept

Invoked when the mouse button state changes.

Parameters
positionThe position of the mouse.
buttonThe button that changed state.
eventThe mouse button event.

◆ onMouseMove() [1/3]

virtual void WindowImpl::onMouseMove ( const Position position,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse is moved.

Parameters
positionThe position of the mouse pointer.
buttonsThe current state of the mouse buttons.

Reimplemented in Split, Button, and Slider.

◆ onMouseMove() [2/3]

virtual void WindowImpl::onMouseMove ( const Position position,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse is moved.

Parameters
positionThe position of the mouse pointer.
buttonsThe current state of the mouse buttons.

Reimplemented in Split, Button, and Slider.

◆ onMouseMove() [3/3]

virtual void WindowImpl::onMouseMove ( const Position position,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse is moved.

Parameters
positionThe position of the mouse pointer.
buttonsThe current state of the mouse buttons.

Reimplemented in Split, Button, and Slider.

◆ onMouseScope() [1/3]

virtual void WindowImpl::onMouseScope ( bool  scope)
virtualnoexcept

Invoked then the mouse pointer enters or exits the scope of the window.

Parameters
scopeSpecified whether or not the pointer is in the scope of the window.

Reimplemented in Split, Button, Button, and Button.

◆ onMouseScope() [2/3]

virtual void WindowImpl::onMouseScope ( bool  scope)
virtualnoexcept

Invoked then the mouse pointer enters or exits the scope of the window.

Parameters
scopeSpecified whether or not the pointer is in the scope of the window.

Reimplemented in Split, Button, Button, and Button.

◆ onMouseScope() [3/3]

virtual void WindowImpl::onMouseScope ( bool  scope)
virtualnoexcept

Invoked then the mouse pointer enters or exits the scope of the window.

Parameters
scopeSpecified whether or not the pointer is in the scope of the window.

Reimplemented in Split, Button, Button, and Button.

◆ onMouseWheel() [1/3]

virtual void WindowImpl::onMouseWheel ( const Position position,
int  delta,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse wheel state changes.

Parameters
positionThe position of the mouse.
deltaThe amount of
buttonsThe current state of the mouse buttons.

◆ onMouseWheel() [2/3]

virtual void WindowImpl::onMouseWheel ( const Position position,
int  delta,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse wheel state changes.

Parameters
positionThe position of the mouse.
deltaThe amount of
buttonsThe current state of the mouse buttons.

◆ onMouseWheel() [3/3]

virtual void WindowImpl::onMouseWheel ( const Position position,
int  delta,
unsigned int  buttons 
)
virtualnoexcept

Invoked when the mouse wheel state changes.

Parameters
positionThe position of the mouse.
deltaThe amount of
buttonsThe current state of the mouse buttons.

◆ onMove() [1/3]

virtual void WindowImpl::onMove ( const Position position)
virtualnoexcept

Invoked when the window has been moved.

Parameters
positionThe new position of the window.

◆ onMove() [2/3]

virtual void WindowImpl::onMove ( const Position position)
virtualnoexcept

Invoked when the window has been moved.

Parameters
positionThe new position of the window.

◆ onMove() [3/3]

virtual void WindowImpl::onMove ( const Position position)
virtualnoexcept

Invoked when the window has been moved.

Parameters
positionThe new position of the window.

◆ onResize() [1/3]

virtual void WindowImpl::onResize ( const Dimension dimension)
virtualnoexcept

Invoked when the window has been resized.

Parameters
dimensionThe new dimension of the window.

Reimplemented in Split, Button, OpenGLContext, and Slider.

◆ onResize() [2/3]

virtual void WindowImpl::onResize ( const Dimension dimension)
virtualnoexcept

Invoked when the window has been resized.

Parameters
dimensionThe new dimension of the window.

Reimplemented in Split, Button, OpenGLContext, and Slider.

◆ onResize() [3/3]

virtual void WindowImpl::onResize ( const Dimension dimension)
virtualnoexcept

Invoked when the window has been resized.

Parameters
dimensionThe new dimension of the window.

Reimplemented in Split, Button, OpenGLContext, and Slider.

◆ onVisibility() [1/3]

virtual void WindowImpl::onVisibility ( Visibility  visibility)
virtualnoexcept

Invoked when the visibility state changes.

◆ onVisibility() [2/3]

virtual void WindowImpl::onVisibility ( Visibility  visibility)
virtualnoexcept

Invoked when the visibility state changes.

◆ onVisibility() [3/3]

virtual void WindowImpl::onVisibility ( Visibility  visibility)
virtualnoexcept

Invoked when the visibility state changes.

◆ openDispatch() [1/3]

bool WindowImpl::openDispatch ( )

This method is responsible for dispatching incoming messages to the corresponding message handlers.

Returns
False if dispatch got an exit message.

◆ openDispatch() [2/3]

bool WindowImpl::openDispatch ( )

This method is responsible for dispatching incoming messages to the corresponding message handlers.

Returns
False if dispatch got an exit message.

◆ openDispatch() [3/3]

bool WindowImpl::openDispatch ( )

This method is responsible for dispatching incoming messages to the corresponding message handlers.

Returns
False if dispatch got an exit message.

◆ raise() [1/3]

void WindowImpl::raise ( )

Raises the window.

◆ raise() [2/3]

void WindowImpl::raise ( )

Raises the window.

◆ raise() [3/3]

void WindowImpl::raise ( )

Raises the window.

◆ releaseCursorConfinement() [1/3]

void WindowImpl::releaseCursorConfinement ( )

Releases the mouse confinement.

◆ releaseCursorConfinement() [2/3]

void WindowImpl::releaseCursorConfinement ( )

Releases the mouse confinement.

◆ releaseCursorConfinement() [3/3]

void WindowImpl::releaseCursorConfinement ( )

Releases the mouse confinement.

◆ setAutorepeat() [1/3]

void WindowImpl::setAutorepeat ( bool  autorepeat)
inline

Sets the autorepeat flag.

◆ setAutorepeat() [2/3]

void WindowImpl::setAutorepeat ( bool  autorepeat)
inline

Sets the autorepeat flag.

◆ setAutorepeat() [3/3]

void WindowImpl::setAutorepeat ( bool  autorepeat)
inline

Sets the autorepeat flag.

◆ setCapture() [1/3]

void WindowImpl::setCapture ( bool  state)

Sets the mouse capture state of the window.

◆ setCapture() [2/3]

void WindowImpl::setCapture ( bool  state)

Sets the mouse capture state of the window.

◆ setCapture() [3/3]

void WindowImpl::setCapture ( bool  state)

Sets the mouse capture state of the window.

◆ setClipping() [1/3]

void WindowImpl::setClipping ( const Position position,
const Dimension dimension 
)

Sets the clipping region.

◆ setClipping() [2/3]

void WindowImpl::setClipping ( const Position position,
const Dimension dimension 
)

Sets the clipping region.

◆ setClipping() [3/3]

void WindowImpl::setClipping ( const Position position,
const Dimension dimension 
)

Sets the clipping region.

◆ setCursor() [1/3]

void WindowImpl::setCursor ( Cursor  cursor)

Sets the mouse cursor of the window.

◆ setCursor() [2/3]

void WindowImpl::setCursor ( Cursor  cursor)

Sets the mouse cursor of the window.

◆ setCursor() [3/3]

void WindowImpl::setCursor ( Cursor  cursor)

Sets the mouse cursor of the window.

◆ setCursorConfinement() [1/6]

void WindowImpl::setCursorConfinement ( )

Sets the cursor confinement to the window context.

◆ setCursorConfinement() [2/6]

void WindowImpl::setCursorConfinement ( )

Sets the cursor confinement to the window context.

◆ setCursorConfinement() [3/6]

void WindowImpl::setCursorConfinement ( )

Sets the cursor confinement to the window context.

◆ setCursorConfinement() [4/6]

void WindowImpl::setCursorConfinement ( const Position position,
const Dimension dimension 
)

Sets the cursor confinement to the specified area.

Parameters
positionThe offset of the confinement area.
dimensionThe dimension of the confinement area.

◆ setCursorConfinement() [5/6]

void WindowImpl::setCursorConfinement ( const Position position,
const Dimension dimension 
)

Sets the cursor confinement to the specified area.

Parameters
positionThe offset of the confinement area.
dimensionThe dimension of the confinement area.

◆ setCursorConfinement() [6/6]

void WindowImpl::setCursorConfinement ( const Position position,
const Dimension dimension 
)

Sets the cursor confinement to the specified area.

Parameters
positionThe offset of the confinement area.
dimensionThe dimension of the confinement area.

◆ setCursorPosition() [1/3]

void WindowImpl::setCursorPosition ( const Position position)

Sets the mouse position.

◆ setCursorPosition() [2/3]

void WindowImpl::setCursorPosition ( const Position position)

Sets the mouse position.

◆ setCursorPosition() [3/3]

void WindowImpl::setCursorPosition ( const Position position)

Sets the mouse position.

◆ setDimension() [1/3]

void WindowImpl::setDimension ( const Dimension dimension)

Sets the size of the window.

◆ setDimension() [2/3]

void WindowImpl::setDimension ( const Dimension dimension)

Sets the size of the window.

◆ setDimension() [3/3]

void WindowImpl::setDimension ( const Dimension dimension)

Sets the size of the window.

◆ setDisplayMode() [1/3]

void WindowImpl::setDisplayMode ( DisplayMode  displayMode)

Selects the display mode.

◆ setDisplayMode() [2/3]

void WindowImpl::setDisplayMode ( DisplayMode  displayMode)

Selects the display mode.

◆ setDisplayMode() [3/3]

void WindowImpl::setDisplayMode ( DisplayMode  displayMode)

Selects the display mode.

◆ setIconTitle() [1/3]

void WindowImpl::setIconTitle ( const String title)

Sets the icon title.

◆ setIconTitle() [2/3]

void WindowImpl::setIconTitle ( const String title)

Sets the icon title.

◆ setIconTitle() [3/3]

void WindowImpl::setIconTitle ( const String title)

Sets the icon title.

◆ setMaximumSize() [1/3]

void WindowImpl::setMaximumSize ( const Dimension dimension)
inline

Sets the maximum size of the window.

◆ setMaximumSize() [2/3]

void WindowImpl::setMaximumSize ( const Dimension dimension)
inline

Sets the maximum size of the window.

◆ setMaximumSize() [3/3]

void WindowImpl::setMaximumSize ( const Dimension dimension)
inline

Sets the maximum size of the window.

◆ setMinimumSize() [1/3]

void WindowImpl::setMinimumSize ( const Dimension dimension)
inline

Sets the minimum size of the window.

◆ setMinimumSize() [2/3]

void WindowImpl::setMinimumSize ( const Dimension dimension)
inline

Sets the minimum size of the window.

◆ setMinimumSize() [3/3]

void WindowImpl::setMinimumSize ( const Dimension dimension)
inline

Sets the minimum size of the window.

◆ setRegion() [1/3]

void WindowImpl::setRegion ( const Position position,
const Dimension dimension 
)

Sets the position and dimension of the window.

◆ setRegion() [2/3]

void WindowImpl::setRegion ( const Position position,
const Dimension dimension 
)

Sets the position and dimension of the window.

◆ setRegion() [3/3]

void WindowImpl::setRegion ( const Position position,
const Dimension dimension 
)

Sets the position and dimension of the window.

◆ setTitle() [1/3]

void WindowImpl::setTitle ( const String title)

Sets the title of the window.

◆ setTitle() [2/3]

void WindowImpl::setTitle ( const String title)

Sets the title of the window.

◆ setTitle() [3/3]

void WindowImpl::setTitle ( const String title)

Sets the title of the window.

◆ show() [1/3]

void WindowImpl::show ( )

Shows the window if currently hidden.

◆ show() [2/3]

void WindowImpl::show ( )

Shows the window if currently hidden.

◆ show() [3/3]

void WindowImpl::show ( )

Shows the window if currently hidden.

◆ toGlobalPosition() [1/3]

Position WindowImpl::toGlobalPosition ( const Position position) const

Returns the position relative to the root window.

Parameters
positionThe position relative to this window.

◆ toGlobalPosition() [2/3]

Position WindowImpl::toGlobalPosition ( const Position position) const

Returns the position relative to the root window.

Parameters
positionThe position relative to this window.

◆ toGlobalPosition() [3/3]

Position WindowImpl::toGlobalPosition ( const Position position) const

Returns the position relative to the root window.

Parameters
positionThe position relative to this window.

◆ update() [1/3]

void WindowImpl::update ( )

Requests the window to be updated.

◆ update() [2/3]

void WindowImpl::update ( )

Requests the window to be updated.

◆ update() [3/3]

void WindowImpl::update ( )

Requests the window to be updated.

◆ wait() [1/6]

void WindowImpl::wait ( )

Waits for a message.

◆ wait() [2/6]

void WindowImpl::wait ( )

Waits for a message.

◆ wait() [3/6]

void WindowImpl::wait ( )

Waits for a message.

◆ wait() [4/6]

bool WindowImpl::wait ( unsigned int  milliseconds)

Waits for a message.

Parameters
millisecondsThe timeout period.

◆ wait() [5/6]

bool WindowImpl::wait ( unsigned int  milliseconds)

Waits for a message.

Parameters
millisecondsThe timeout period.

◆ wait() [6/6]

bool WindowImpl::wait ( unsigned int  milliseconds)

Waits for a message.

Parameters
millisecondsThe timeout period.

Member Data Documentation

◆ dimension

Dimension WindowImpl::dimension
protected

The dimension of the window.

◆ displayHandle

static void * WindowImpl::displayHandle
staticprotected

Opaque handle to the display.

◆ flags

unsigned int WindowImpl::flags = 0
protected

Flags.

◆ graphicsContextHandle

void * WindowImpl::graphicsContextHandle = nullptr
protected

Opaque handle to the graphics context of the window.

◆ iconTitle

String WindowImpl::iconTitle
protected

The icon title of the window.

◆ maximumSize

Dimension WindowImpl::maximumSize
protected

The maximum dimension of the window.

◆ minimumSize

Dimension WindowImpl::minimumSize
protected

The minimum dimension of the window.

◆ position

Position WindowImpl::position
protected

The position of the window.

◆ screenHandle

void * WindowImpl::screenHandle = nullptr
protected

Opaque handle to the screen.

◆ title

String WindowImpl::title
protected

The normal title of the window.