GUIFactory Class Reference

The GUIFactory object represents a C++ object that provides access to GUI objects such as CameraSelectionWindow, PropertyGridWindow and dialogs defined in GUI XML. More...

#include <SpinnakerGUI_WPF.h>

Public Member Functions
	GUIFactory ()
	Default constructor.
	~GUIFactory ()
	Default destructor.
bool	ConnectGUILibrary (Spinnaker::CameraPtr *camera)
	Connect GUI Factory to camera object.
void	DisconnectGUILibrary ()
	Disconnect GUI Factory from camera object.
bool	IsConnected ()
	Get a boolean indicating whether GUI Factory is connected to a camera object.
PropertyGridWindow *	GetPropertyGridWindow ()
	Get PropertyGridWindow from GUI Factory.
CameraSelectionWindow *	GetCameraSelectionWindow ()
	Get Camera Selection Window from GUI Factory.
ImageDrawingWindow *	GetImageDrawingWindow ()
	Get Image Drawing Window.
int	GetNumOfDialogs ()
	Get number of dialogs contained in GUI Factory.
std::list< std::string >	GetDialogNameList ()
	Get a list of dialog names.
void	ShowDialogByName (std::string dialogName)
	Display dialog with specific name.
void	ShowDialogByIndex (int index)
	Display dialog at specific name list index.
void	HideDialogByName (std::string dialogName)
	Hide dialog by specific name.
void	HideDialogByIndex (int index)
	Hide dialog at specific name list index.
int	GetNumOfControls ()
	Return number of controls contained in GUI Factory.
std::list< std::string >	GetControlNameList ()
	Return a string list of controls.

Detailed Description

The GUIFactory object represents a C++ object that provides access to GUI objects such as CameraSelectionWindow, PropertyGridWindow and dialogs defined in GUI XML.

Constructor & Destructor Documentation

GUIFactory()

GUIFactory

(

)

Default constructor.

~GUIFactory()

~GUIFactory

(

)

Default destructor.

Member Function Documentation

ConnectGUILibrary()

bool ConnectGUILibrary

(

Spinnaker::CameraPtr *

camera

)

Connect GUI Factory to camera object.

Parameters

camera

pointer to a camera object

Returns

boolean indicating whether operation was successful

DisconnectGUILibrary()

void DisconnectGUILibrary

(

)

Disconnect GUI Factory from camera object.

GetCameraSelectionWindow()

CameraSelectionWindow * GetCameraSelectionWindow

(

)

Get Camera Selection Window from GUI Factory.

Returns

A pointer to CameraSelectionWindow. User has ownership of this pointer.

GetControlNameList()

std::list< std::string > GetControlNameList

(

)

Return a string list of controls.

Returns

list of control names

GetDialogNameList()

std::list< std::string > GetDialogNameList

(

)

Get a list of dialog names.

Returns

string list of dialog names

GetImageDrawingWindow()

ImageDrawingWindow * GetImageDrawingWindow

(

)

Get Image Drawing Window.

Returns

A pointer to ImageDrawingWindow. User has ownership of this pointer.

GetNumOfControls()

int GetNumOfControls

(

)

Return number of controls contained in GUI Factory.

Returns

number of controls

GetNumOfDialogs()

int GetNumOfDialogs

(

)

Get number of dialogs contained in GUI Factory.

Returns

number of dialogs

GetPropertyGridWindow()

PropertyGridWindow * GetPropertyGridWindow

(

)

Get PropertyGridWindow from GUI Factory.

Returns

A pointer to PropertyGridWindow. User has ownership of this pointer.

HideDialogByIndex()

void HideDialogByIndex

(

int

index

)

Hide dialog at specific name list index.

Parameters

index

name index of dialog to be hidden

HideDialogByName()

void HideDialogByName

(

std::string

dialogName

)

Hide dialog by specific name.

Parameters

dialogName

name of dialog to be hidden

IsConnected()

bool IsConnected

(

)

Get a boolean indicating whether GUI Factory is connected to a camera object.

Returns

boolean indicating connection status.

ShowDialogByIndex()

void ShowDialogByIndex

(

int

index

)

Display dialog at specific name list index.

Parameters

index

name index of dialog to be shown

ShowDialogByName()

void ShowDialogByName

(

std::string

dialogName

)

Display dialog with specific name.

Parameters

dialogName

string holding dialog name

---

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

• include/GUI/SpinnakerGUI_WPF.h