CFxUIDialog Class Reference

#include <FxUIDialog.h>

Inheritance diagram for CFxUIDialog:

Public Types
enum	DialogCode { Rejected , Accepted }

Public Member Functions
	CFxUIDialog ()
	~CFxUIDialog ()
virtual void	setupUi ()=0
virtual unsigned int	GetHelpId () const
virtual const char *	GetHelpURL () const
CFxUIBaseView *	GetLayout ()
virtual int	exec (bool bEnableViewOperation=false)
void	hide ()
void	setVisible (bool bVisible)
bool	isVisible ()
void	setResult (int iResult)
int	result () const
CFxUIString	windowTitle ()
void	setWindowTitle (const CFxUIString &strTitle)
void	openHelp ()
void	setFloating (bool floating)
virtual void	showEvent (CFxUIShowEvent *event)
virtual void	hideEvent (CFxUIHideEvent *event)
virtual void	accept ()
virtual void	reject ()
virtual void	done (int r)
CFxUISignal< void(void)> &	accepted ()
CFxUISignal< void(void)> &	rejected ()
CFxUISignal< void(int)> &	finished ()
Public Member Functions inherited from CFxUIObject
	CFxUIObject ()
virtual	~CFxUIObject ()
FxNativeHandle	getHandle () const
void	setHandle (FxNativeHandle handle)
void	setParent (CFxUIObject *parent)
CFxUIObject *	parent ()
const CFxUIObject *	parent () const
void	setObjectName (const CFxUIString &objectName)
CFxUIString	objectName () const
bool	setProperty (const char *name, const CFxUIVariant &value)
CFxUIVariant	property (const char *name)
CFxUIList< CFxUIObject * >	children () const
template<typename T >
CFxUIList< T >	findChildren (const CFxUIString &name=CFxUIString())
void	blockSignals (bool block)
bool	signalsBlocked () const

Additional Inherited Members
Protected Member Functions inherited from CFxUIObject
CFxUIObject *	sender ()
Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl *	m_pImpl
CFxUIObjectData *	m_pData

Detailed Description

Class CFxUIDialog is the base class for all dialogs.

Definition at line 29 of file FxUIDialog.h.

Member Enumeration Documentation

DialogCode

enum CFxUIDialog::DialogCode

Description: The value returned by a modal dialog.

Enumerator
Rejected
Accepted

Definition at line 35 of file FxUIDialog.h.

Constructor & Destructor Documentation

CFxUIDialog()

CFxUIDialog::CFxUIDialog

(

)

Constructor

~CFxUIDialog()

CFxUIDialog::~CFxUIDialog

(

)

Destructor

Member Function Documentation

accept()

virtual void CFxUIDialog::accept ( )

virtual

Hides the modal dialog and sets the result code to Accepted.

accepted()

CFxUISignal< void(void)> & CFxUIDialog::accepted

(

)

This signal is emitted when the dialog has been accepted either by the user

or by calling accept() or done() with the CFxUIDialog::Accepted argument.

done()

virtual void CFxUIDialog::done ( int  r )

virtual

Hides the modal dialog and sets the result code to r.

Parameters

r

Input.

exec()

virtual int CFxUIDialog::exec ( bool  bEnableViewOperation = false )

virtual

Shows the dialog as modal widget.

Parameters

bEnableViewOperation

- the parameter allows view modifications with pan and pinch gestures.

The parameter works only on touch platforms.

Returns

The DialogCode.

finished()

CFxUISignal< void(int)> & CFxUIDialog::finished

(

)

This signal is emitted when the dialog's result code has been set,

either by the user or by calling done(), accept(), or reject().

GetHelpId()

virtual unsigned int CFxUIDialog::GetHelpId ( ) const

virtual

Returns help id of the dialog.

ByDefault it's value will be Zero.

Returns

The dialog's help id

GetHelpURL()

virtual const char * CFxUIDialog::GetHelpURL ( ) const

virtual

Returns help URL of the dialog.

Returns

The dialog's help URL

GetLayout()

CFxUIBaseView * CFxUIDialog::GetLayout

(

)

Returns layout of the dialog.

Returns

The dialog's layout

hide()

void CFxUIDialog::hide

(

)

Hides the modal dialog.

hideEvent()

virtual void CFxUIDialog::hideEvent ( CFxUIHideEvent *  event )

virtual

This event handler can be reimplemented in a subclass to receive dialog hide events which are passed in the event parameter.

Hide events are sent to dialogs immediately before they are hidden.

isVisible()

bool CFxUIDialog::isVisible

(

)

openHelp()

void CFxUIDialog::openHelp

(

)

Opens contextual help for the dialog.

reject()

virtual void CFxUIDialog::reject ( )

virtual

Hides the modal dialog and sets the result code to Rejected.

rejected()

CFxUISignal< void(void)> & CFxUIDialog::rejected

(

)

This signal is emitted when the dialog has been rejected either by the user

or by calling reject() or done() with the CFxUIDialog::Rejected argument.

result()

int CFxUIDialog::result

(

)

const

Returns result code of the modal dialog

Returns

The DialogCode, Accepted or Rejected.

setFloating()

void CFxUIDialog::setFloating

(

bool

floating

)

A floating dialog is presented to the user as an independent window "on top" of its parent, instead of being docked.

The function works only on touch platforms.

setResult()

void CFxUIDialog::setResult

(

int

iResult

)

Sets result code of the modal dialog

Parameters

iResult

Input.

setupUi()

virtual void CFxUIDialog::setupUi ( )

pure virtual

It will contain creation logic of all widgets in a dialog.

setVisible()

void CFxUIDialog::setVisible

(

bool

bVisible

)

Sets visibility of the modal dialog.

Parameters

bVisible

The dialog is visible if the value of the parameter is true, otherwise it will be invisible.

setWindowTitle()

void CFxUIDialog::setWindowTitle

(

const CFxUIString &

strTitle

)

Sets title of the modal dialog

Parameters

strTitle

Input.

showEvent()

virtual void CFxUIDialog::showEvent ( CFxUIShowEvent *  event )

virtual

This event handler can be reimplemented in a subclass to receive dialog show events which are passed in the event parameter.

Show events are sent to dialogs immediately before they are shown.

windowTitle()

CFxUIString CFxUIDialog::windowTitle

(

)

Returns title of the modal dialog

---

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

• FxUIDialog.h