Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvWnd Class Reference

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.
 

Detailed Description

Base class defining common functionality for all user interface classes.

Member Function Documentation

◆ Close()

PvResult PvWnd::Close ( )

Close the window.

Returns
Includes:

◆ GetPosition()

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.

Parameters
[out]aPosXSee SetPosition.
[out]aPosYSee SetPosition.
[out]aSizeXSee SetPosition.
[out]aSizeYSee SetPosition.

◆ GetTitle()

PvString PvWnd::GetTitle ( ) const

Get the window's title.

Returns
The window's title.
See also
SetTitle

◆ SetPosition()

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.

Parameters
[in]aPosXThe window's position - left edge.
[in]aPosYThe window's position - top edge.
[in]aSizeXThe window's size - width.
[in]aSizeYThe window's size - height.
See also
GetPosition

◆ SetTitle()

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.

Parameters
[in]aTitleThe window's new title.
See also
GetTitle

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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com