libnick 2025.7.3
A cross-platform base for native Nickvision applications.
Loading...
Searching...
No Matches
Nickvision::App::WindowGeometry Class Reference

A model of a window's geometry. More...

#include <windowgeometry.h>

Public Member Functions

 WindowGeometry ()
 Construct a WindowGeometry.
 WindowGeometry (long width, long height, bool isMaximized)
 Construct a WindowGeometry.
 WindowGeometry (long width, long height, bool isMaximized, long x, long y)
 Construct a WindowGeometry.
 WindowGeometry (boost::json::object json)
 Constructs a WindowGeometry.
long getWidth () const
 Gets the width of the window.
void setWidth (long width)
 Sets the width of the window.
long getHeight () const
 Gets the height of the window.
void setHeight (long height)
 Sets the height of the window.
bool isMaximized () const
 Gets whether or not the window is maximized.
void setIsMaximized (bool isMaximized)
 Sets whether or not the window is maximized.
long getX () const
 Gets the x position of the window.
void setX (long x)
 Sets the x position of the window.
long getY () const
 Gets the y position of the window.
void setY (long y)
 Sets the y position of the window.
boost::json::object toJson () const
 Converts the WindowGeometry to a json object.

Detailed Description

A model of a window's geometry.

Constructor & Destructor Documentation

◆ WindowGeometry() [1/4]

Nickvision::App::WindowGeometry::WindowGeometry ( )

Construct a WindowGeometry.

◆ WindowGeometry() [2/4]

Nickvision::App::WindowGeometry::WindowGeometry ( long width,
long height,
bool isMaximized )

Construct a WindowGeometry.

Parameters
widthThe width of the window
heightThe height of the window
isMaximizedWhether or not the window is maximized

◆ WindowGeometry() [3/4]

Nickvision::App::WindowGeometry::WindowGeometry ( long width,
long height,
bool isMaximized,
long x,
long y )

Construct a WindowGeometry.

Parameters
widthThe width of the window
heightThe height of the window
isMaximizedWhether or not the window is maximized
xThe x position of the window
yThe y position of the window

◆ WindowGeometry() [4/4]

Nickvision::App::WindowGeometry::WindowGeometry ( boost::json::object json)

Constructs a WindowGeometry.

Parameters
jsonThe json object

Member Function Documentation

◆ getHeight()

long Nickvision::App::WindowGeometry::getHeight ( ) const

Gets the height of the window.

Returns
The height of the window

◆ getWidth()

long Nickvision::App::WindowGeometry::getWidth ( ) const

Gets the width of the window.

Returns
The width of the window

◆ getX()

long Nickvision::App::WindowGeometry::getX ( ) const

Gets the x position of the window.

Returns
The x position of the window

◆ getY()

long Nickvision::App::WindowGeometry::getY ( ) const

Gets the y position of the window.

Returns
The y position of the window

◆ isMaximized()

bool Nickvision::App::WindowGeometry::isMaximized ( ) const

Gets whether or not the window is maximized.

Returns
True if maximized, else false

◆ setHeight()

void Nickvision::App::WindowGeometry::setHeight ( long height)

Sets the height of the window.

Parameters
heightThe new height of the window

◆ setIsMaximized()

void Nickvision::App::WindowGeometry::setIsMaximized ( bool isMaximized)

Sets whether or not the window is maximized.

Parameters
isMaximizedTrue if maximized, else false

◆ setWidth()

void Nickvision::App::WindowGeometry::setWidth ( long width)

Sets the width of the window.

Parameters
widthThe new width of the window

◆ setX()

void Nickvision::App::WindowGeometry::setX ( long x)

Sets the x position of the window.

Parameters
xThe new x position of the window

◆ setY()

void Nickvision::App::WindowGeometry::setY ( long y)

Sets the y position of the window.

Parameters
xThe new y position of the window

◆ toJson()

boost::json::object Nickvision::App::WindowGeometry::toJson ( ) const

Converts the WindowGeometry to a json object.

Returns
The json representation of the WindowGeometry

The documentation for this class was generated from the following file: