Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
Public Member Functions | List of all members
PvGenBrowserWnd Class Reference

Feature-controller window. More...

Public Member Functions

 PvGenBrowserWnd ()
 Constructor.
 
void SetGenParameterArray (PvGenParameterArray *aArray)
 Assign the feature list to be controlled.
 
virtual bool IsParameterDisplayed (PvGenParameter *aParameter)
 Callback - Test if a parameter should be displayed.
 
PvResult SetVisibility (PvGenVisibility aVisibility)
 Set the highest visibility level to display in the tree browser window.
 
PvGenVisibility GetVisibility ()
 Returns the highest visibility level displayed in the tree browser window.
 
PvResult SetRefreshMode (PvGenRefresh aRefreshMode)
 Set the refresh mode for the browser.
 
PvGenRefresh GetRefreshMode ()
 Returns the current refresh mode of the browser.
 
PvResult Save (PvPropertyList &aPropertyList)
 Persists the current browser options.
 
PvResult Load (PvPropertyList &aPropertyList)
 Restores a browser options.
 
void Refresh ()
 Refreshes the content of the browser.
 
- Public Member Functions inherited from PvWnd
void SetPosition (int32_t aPosX, int32_t aPosY, int32_t aSizeX, int32_t aSizeY)
 Set the window's position and size.
 
void GetPosition (int32_t &aPosX, int32_t &aPosY, int32_t &aSizeX, int32_t &aSizeY)
 Get the window's position and size.
 
PvResult ShowModal ()
 Display the window (modal).
 
PvResult ShowModal (QWidget *aParentHwnd)
 Display the window (modal).
 
PvResult Create (QWidget *aHwnd)
 Display the window (embedded in your program's window).
 
PvResult ShowModeless ()
 Display the window (non-modal).
 
PvResult ShowModeless (QWidget *aParentHwnd)
 Display the window (non-modal).
 
QWidget * GetQWidget ()
 Get the display controller's (PvWnd object) handle.
 
PvString GetTitle () const
 Get the window's title.
 
void SetTitle (const PvString &aTitle)
 Set the window's title.
 
PvResult Close ()
 Close the window.
 

Additional Inherited Members

- Static Public Member Functions inherited from PvWnd
static void DoEvents ()
 Processes all pending events for the calling thread.
 
- Protected Member Functions inherited from PvWnd
 PvWnd ()
 Constructor.
 
virtual ~PvWnd ()
 Destructor.
 

Detailed Description

Feature-controller window.

To control features (using a GUI):

  1. Create a feature-controller window (PvGenBrowserWnd object). Use PvGenBrowserWnd::PvGenBrowserWnd.
  2. Assign the feature list to be controlled. Use SetGenParameterArray.
  3. Optionally, set the window's position and titlebar name. Use SetPosition and SetTitle.

Member Function Documentation

◆ GetRefreshMode()

PvGenRefresh PvGenBrowserWnd::GetRefreshMode ( )

Returns the current refresh mode of the browser.

Return values
Thecurrent refresh mode.

◆ GetVisibility()

PvGenVisibility PvGenBrowserWnd::GetVisibility ( )

Returns the highest visibility level displayed in the tree browser window.

Return values
Thehighest visibility level displayed in the tree browser.

◆ IsParameterDisplayed()

bool PvGenBrowserWnd::IsParameterDisplayed ( PvGenParameter *  aParameter)
virtual

Callback - Test if a parameter should be displayed.

Override the IsParameterDisplayed method to test if a parameter should be displayed or not. By default, IsParameterDisplayed always returns true.

Parameters
[in]aParameterThe parameter's ID.
Return values
Bydefault, IsParameterDisplayed always returns true. When overriding, return true if the parameter should be displayed; otherwise, false.

◆ Load()

PvResult PvGenBrowserWnd::Load ( PvPropertyList &  aPropertyList)

Restores a browser options.

The load works on a best effort basis. Whatever can be restored will be restored.

The order to properties in the aPropertyList is not important.

Parameters
[in]aPropertyListA list of pairs of names/values.
Returns
Includes:

◆ Refresh()

void PvGenBrowserWnd::Refresh ( )

Refreshes the content of the browser.

When in automatic or polling time mode, the browser refreshes itself autonomously. When in manual mode, refresh operations are triggered by the refresh button of the browser or they can be triggered with this method.

This method refreshes the parameters of the browser but it is possible (and likely) that some parameter values are stored in the register cache of the parameter array.

To refresh (invalidate) the register cache, call PvGenParameterArray::InvalidateCache. This should in turn cause all the parameters of the browser to be updated.

This operation is performed in the the context of the user interface.

◆ Save()

PvResult PvGenBrowserWnd::Save ( PvPropertyList &  aPropertyList)

Persists the current browser options.

This call builds a list of properties containing pairs of names/values.

Parameters
[in]aPropertyListA list of pairs of names/values.
Returns
Includes:

◆ SetGenParameterArray()

void PvGenBrowserWnd::SetGenParameterArray ( PvGenParameterArray *  aArray)

Assign the feature list to be controlled.

Parameters
[in]aArrayThe feature list to be controlled; a PvGenParameterArray object.

◆ SetRefreshMode()

PvResult PvGenBrowserWnd::SetRefreshMode ( PvGenRefresh  aRefreshMode)

Set the refresh mode for the browser.

Parameters
[in]aRefreshModeThe refresh mode to set.
Returns
Includes:

◆ SetVisibility()

PvResult PvGenBrowserWnd::SetVisibility ( PvGenVisibility  aVisibility)

Set the highest visibility level to display in the tree browser window.

Parameters
[in]aVisibilityThe visibility level to set; a PvGenVisibility object.
The documentation for this class was generated from the following files:

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