Base class defining common functionality for all user interface classes. More...
Public Member Functions | |
void | SetPosition (int32_t aPosX, int32_t aPosY, int32_t aSizeX, int32_t aSizeY) |
Set the window's position and size. More... | |
void | GetPosition (int32_t &aPosX, int32_t &aPosY, int32_t &aSizeX, int32_t &aSizeY) |
Get the window's position and size. More... | |
PvString | GetTitle () const |
Get the window's title. More... | |
void | SetTitle (const PvString &aTitle) |
Set the window's title. More... | |
PvResult | Close () |
Close the window. More... | |
Protected Member Functions | |
PvWnd () | |
Constructor. | |
virtual | ~PvWnd () |
Destructor. | |
Base class defining common functionality for all user interface classes.
PvResult PvWnd::Close | ( | ) |
Close the window.
void PvWnd::GetPosition | ( | int32_t & | aPosX, |
int32_t & | aPosY, | ||
int32_t & | aSizeX, | ||
int32_t & | aSizeY | ||
) |
Get the window's position and size.
To use this method, see SetPosition.
[out] | aPosX | See SetPosition. |
[out] | aPosY | See SetPosition. |
[out] | aSizeX | See SetPosition. |
[out] | aSizeY | See SetPosition. |
PvString PvWnd::GetTitle | ( | ) | const |
void PvWnd::SetPosition | ( | int32_t | aPosX, |
int32_t | aPosY, | ||
int32_t | aSizeX, | ||
int32_t | aSizeY | ||
) |
Set the window's position and size.
For standalone windows, the SetPosition method sets the window's absolute position (and size) on the desktop, where (0,0) is the top left corner of the desktop.
For embedded windows, the SetPosition method sets the embedded window's position relative to the window in which it is embedded, where (0,0) is the top left corner of the window.
Coordinates of the window's top left corner: (aPosX, aPosY)
Coordinates of the window's bottom right corner: (aPosX+aSizeX, aPosY+aSizeY)
To get the window's current position and size, use GetPosition.
[in] | aPosX | The window's position - left edge. |
[in] | aPosY | The window's position - top edge. |
[in] | aSizeX | The window's size - width. |
[in] | aSizeY | The window's size - height. |
void PvWnd::SetTitle | ( | const PvString & | aTitle | ) |
Set the window's title.
The title appears in the (typically blue) band at the top of the window.
[in] | aTitle | The window's new title. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com