#include <LightApp_PreferencesDlg.h>

Inheritance diagram for LightApp_PreferencesDlg:

Public Types
enum	PlacePolicy { Position, Expand, Uniform }
	Buttons alignment type. More...
enum	ButtonArea { TopArea, BottomArea, LeftArea, RightArea }
	Buttons area. More...
enum	ButtonPosition { Left, Right, Center, Top = Left, Bottom = Right }
	Button position. More...
enum	ButtonFlags { None = 0x00000000, OK = 0x00000001, Apply = 0x00000002, Cancel = 0x00000004, Yes = 0x00000008, No = 0x00000010, Close = 0x00000020, Help = 0x00000040, OKCancel = OK \| Cancel, YesNo = Yes \| No, Standard = OK \| Cancel \| Help, All = Standard \| YesNo \| Apply \| Close }
	Button ID flags. More...
enum	DialogFlags { Accept = 0x000001, Reject = 0x000002, AlignOnce = 0x000004, SetFocus = 0x000008 }
	Dialog box flags. More...
Public Slots
void	update ()
	Update dialog box.
Signals
void	dlgButton (int)
	Emitted when the user button is clicked.
void	dlgParamChanged ()
	This signal can be used in successor classes to signalize about some dialog parameter changing.
void	dlgHelp ()
	Emitted when the "Help" button is clicked.
void	dlgApply ()
	Emitted when the "Apply" button is clicked.
void	dlgOk ()
	Emitted when the "OK" button is clicked.
void	dlgNo ()
	Emitted when the "No" button is clicked.
void	dlgYes ()
	Emitted when the "Yes" button is clicked.
void	dlgClose ()
	Emitted when the "Close" button is clicked.
void	dlgCancel ()
	Emitted when the "Cancel" button is clicked.
Public Member Functions
	LightApp_PreferencesDlg (LightApp_Preferences , QWidget =0)
virtual	~LightApp_PreferencesDlg ()
virtual void	setVisible (bool visible)
virtual void	accept ()
virtual void	reject ()
bool	isSaved ()
void	setSaved (bool saved)
void	setDialogFlags (const int)
	Set specified dialog box flags.
void	clearDialogFlags (const int)
	Clear specified the dialog flags.
bool	testDialogFlags (const int) const
	Test specified dialog flags.
void	setButtonFlags (const int)
	Add specified control button(s) to the dialog box.
void	clearButtonFlags (const int)
	Remove specified control button(s) from the dialog box.
bool	testButtonFlags (const int) const
	Test specified buttons.
int	buttonPosition (const int) const
	Get specified control button position.
void	setButtonPosition (const int, const int=-1)
	Set the specified control button(s) position.
void	setPlacePosition (const int, const int)
	Set button position for all buttons in specified area.
int	placePolicy (const int) const
	Get buttons layouting policy for the specified area.
void	setPlacePolicy (const int, const int)
	set buttons layouting policy for the specified area.
void	setButtonPlace (const int, const int)
	Move specified button(s) into specified area.
QString	buttonText (const int)
	Get specified button's text.
void	setButtonText (const int, const QString &text)
	Set specified button's text.
void	setButtonFocus (const int)
	Sets the keyboard focus to the specified button.
bool	hasButtonFocus (const int) const
	Check if specified button has keyboard focus.
bool	isButtonEnabled (const int) const
	Get "enabled" status of the specified button(s).
void	setButtonEnabled (const bool, const int)
	Enable/disable specified button(s).
bool	isBorderEnabled (const int) const
	Check if border is enabled.
void	setBorderEnabled (const bool, const int)
	Show/hide border for the specified button area.
void	removeButton (const int)
	Remove user button.
int	insertButton (const QString &, const int=BottomArea)
	Add user button to the dialog box.
QIntList	userButtonIds () const
	Get all user button IDs.
QAbstractButton *	userButton (const int) const
	Get user button by the specified id.
uint	setAlignment (uint align)
	Sets alignment policy.
Static Public Member Functions
static void	setUnits (QLabel *, const QString &)
	Set measure units to the specified label.
Protected Types
typedef QMap< int, QAbstractButton * >	ButtonMap
	button map
Protected Member Functions
int	buttonPosition (QAbstractButton *) const
	Get position of specified button.
QFrame *	mainFrame () const
	Get dialog box main frame widget.
virtual bool	acceptData () const
	Check if data entered by the user is valid.
virtual bool	rejectData () const
	Check if dialog box can be cancelled.
virtual QAbstractButton *	createButton (QWidget *)
	Create new user button.
QAbstractButton *	button (const int) const
	Get button by the specified ID.
ButtonMap	buttons (const int=All) const
	Get buttons by the specified IDs.
int	buttonId (const QAbstractButton *) const
	Get specified button's identifier.
virtual void	showEvent (QShowEvent *)
	Align this dialog according to the parent widget and alignment policy before the dialog box is shown.
virtual void	hideEvent (QHideEvent *)
	Process all existing events when dialog box is hidden.
virtual void	closeEvent (QCloseEvent *)
	Called when user closes dialog box.
virtual void	childEvent (QChildEvent *)
	Update dialog box layout when the size grip is added.
virtual void	keyPressEvent (QKeyEvent *)
	Process key pressing event.
Private Slots
void	onHelp ()
void	onApply ()
void	onDefault ()
void	onImportPref ()
Private Attributes
LightApp_Preferences *	myPrefs
bool	mySaved

Detailed Description

Dialog for preferences edition

Member Typedef Documentation

typedef QMap<int, QAbstractButton*> QtxDialog.ButtonMap [protected, inherited]

Member Enumeration Documentation

enum QtxDialog::PlacePolicy [inherited]

Enumerator:

Position	buttons are placed according their position
Expand	buttons occupy all available space
Uniform	buttons are uniformly placed in the area

enum QtxDialog::ButtonArea [inherited]

Enumerator:

TopArea	horizontal area at the top side of the dialog box
BottomArea	horizontal area at the bottom side of the dialog box
LeftArea	vertical area at the left side of the dialog box
RightArea	vertical area at the right side of the dialog box

enum QtxDialog::ButtonPosition [inherited]

Enumerator:

Left	set button left-most
Right	set button right-most
Center	place button in the center
Top	set button top-most
Bottom	set button bottom-most

enum QtxDialog::ButtonFlags [inherited]

Enumerator:

None	no button used
OK	OK button.
Apply	Apply button.
Cancel	Cancel button.
Yes	Yes button.
No	No button.
Close	Close button.
Help	Help button.
OKCancel	OK & Cancel button.
YesNo	Yes & No buttons.
Standard	OK, Cancel & Help buttons.
All	all buttons

enum QtxDialog::DialogFlags [inherited]

Enumerator:

Accept	allow dialog box accepting control
Reject	allow dialog box rejecting control
AlignOnce	align dialog box only when it is first time shown
SetFocus	allow to set focus on dialog box when it is shown (user can use setFocusProxy() and specify own initial focus widget)

Constructor & Destructor Documentation

LightApp_PreferencesDlg::LightApp_PreferencesDlg	(	LightApp_Preferences *	prefs,
		QWidget *	parent = `0`
	)

Constructor.

References QtxDialog.AlignOnce, QtxDialog.Close, QtxDialog.dlgApply(), QtxDialog.dlgHelp(), QtxDialog.insertButton(), main(), QtxDialog.mainFrame(), myPrefs, onApply(), onDefault(), onHelp(), onImportPref(), QtxDialog.Right, QtxDialog.setButtonPosition(), QtxDialog.setDialogFlags(), and QtxDialog.userButton().

LightApp_PreferencesDlg::~LightApp_PreferencesDlg ( ) [virtual]

Destructor.

References QtxDialog.mainFrame(), and myPrefs.

Member Function Documentation

void LightApp_PreferencesDlg::setVisible ( bool visible ) [virtual]

Show/hide dialog.

Reimplemented from QtxDialog.

References myPrefs, QtxPreferenceMgr.retrieve(), and QtxPreferenceMgr.toBackup().

void LightApp_PreferencesDlg::accept ( ) [virtual]

Store preferences on accept.

Reimplemented from QtxDialog.

References myPrefs, mySaved, and QtxPreferenceMgr.store().

void LightApp_PreferencesDlg::reject ( ) [virtual]

Reject. Restore preferences from backup.

Reimplemented from QtxDialog.

References QtxPreferenceMgr.fromBackup(), and myPrefs.

bool LightApp_PreferencesDlg.isSaved ( )

void LightApp_PreferencesDlg.setSaved ( bool saved )

void LightApp_PreferencesDlg::onHelp ( ) [private, slot]

Do nothing.

void LightApp_PreferencesDlg::onApply ( ) [private, slot]

Store preferences on apply.

References myPrefs, mySaved, QtxPreferenceMgr.retrieve(), QtxPreferenceMgr.store(), and QtxPreferenceMgr.toBackup().

void LightApp_PreferencesDlg::onDefault ( ) [private, slot]

Restore default preferences

References QtxResourceMgr.IgnoreUserValues, myPrefs, SUIT_MessageBox.question(), QtxPreferenceMgr.resourceMgr(), QtxPreferenceMgr.retrieve(), QtxResourceMgr.setWorkingMode(), and QtxResourceMgr.workingMode().

void LightApp_PreferencesDlg::onImportPref ( ) [private, slot]

Import preferences from some file

References QtxResourceMgr.import(), myPrefs, QtxPreferenceMgr.resourceMgr(), QtxPreferenceMgr.retrieve(), and QtxPreferenceMgr.toBackup().

void QtxDialog::setDialogFlags ( const int f ) [inherited]

Parameters:

f	dialog box flags (QtxDialog.DialogFlags)

See also:: clearDialogFlags(), testDialogFlags(), acceptData(), rejectData()

References QtxDialog.myDialogFlags.

void QtxDialog::clearDialogFlags ( const int f ) [inherited]

Parameters:

f	dialog box flags (QtxDialog.DialogFlags)

See also:: setDialogFlags(), testDialogFlags()

References QtxDialog.myDialogFlags.

bool QtxDialog::testDialogFlags ( const int f ) const [inherited]

Returns:: true if specified dialog box falgs are set

See also:: setDialogFlags(), clearDialogFlags()

References QtxDialog.myDialogFlags.

void QtxDialog::setButtonFlags ( const int f ) [inherited]

Parameters:

f	ORed buttons flags (Qtx.ButtonFlags)

See also:: clearButtonFlags(), testButtonFlags()

References QtxDialog.myButtonFlags, and QtxDialog.update().

void QtxDialog::clearButtonFlags ( const int f ) [inherited]

Parameters:

f	ORed buttons flags (Qtx.ButtonFlags)

See also:: setButtonFlags(), testButtonFlags()

References QtxDialog.myButtonFlags, and QtxDialog.update().

bool QtxDialog::testButtonFlags ( const int f ) const [inherited]

Returns:: true if specified control buttons are used in the dialog box

See also:: setButtonFlags(), clearButtonFlags()

References QtxDialog.myButtonFlags.

int QtxDialog::buttonPosition ( const int id ) const [inherited]

Parameters:

id	control button ID (QtxDialog.ButtonFlags)

Returns:: button's position (QtxDialog.ButtonPosition) or -1 if it is not set or invalid id is given

See also:: setButtonPosition()

References QtxDialog.myPosition.

int QtxDialog::buttonPosition ( QAbstractButton * b ) const [protected, inherited]

Parameters:

b button

Returns:: button position (QtxDialog.ButtonPosition)

References QtxDialog.buttonId(), and QtxDialog.buttonPosition().

void QtxDialog::setButtonPosition	(	const int	pos,
		const int	id = `-1`
	)		`[inherited]`

Parameters:

id	control button(s) ID (QtxDialog.ButtonFlags)
pos	button(s) position (QtxDialog.ButtonPosition)

References QtxDialog.button(), QtxDialog.buttons(), QtxDialog.myArea, and QtxDialog.myPosition.

void QtxDialog::setPlacePosition	(	const int	pos,
		const int	area
	)		`[inherited]`

Parameters:

pos	button(s) position (QtxDialog.ButtonPosition)
area	buttons area (QtxDialog.ButtonArea)

See also:: setButtonPosition()

References QtxDialog.Area.contains(), QtxDialog.Area.layoutButtons(), QtxDialog.myArea, QtxDialog.myButton, and QtxDialog.myPosition.

int QtxDialog::placePolicy ( const int area ) const [inherited]

Parameters:

area	buttons area (QtxDialog.ButtonArea)

See also:: setPlacePolicy()

References QtxDialog.myArea.

void QtxDialog::setPlacePolicy	(	const int	policy,
		const int	area
	)		`[inherited]`

Parameters:

policy	buttons layouting policy (QtxDialog.PlacePolicy)
area	buttons area (QtxDialog.ButtonArea)

See also:: placePolicy()

References QtxDialog.myArea.

void QtxDialog::setButtonPlace	(	const int	area,
		const int	id
	)		`[inherited]`

Parameters:

area	buttons area (QtxDialog.ButtonArea)
id	control button(s) ID (QtxDialog.ButtonFlags)

References QtxDialog.buttons(), QtxDialog.Area.insertButton(), QtxDialog.myArea, and QtxDialog.Area.removeButton().

QString QtxDialog::buttonText ( const int id ) [inherited]

Parameters:

id	control button ID (QtxDialog.ButtonFlags)

Returns:: button's text

See also:: setButtonText()

References QtxDialog.button().

void QtxDialog::setButtonText	(	const int	id,
		const QString &	text
	)		`[inherited]`

Parameters:

id	control button ID (QtxDialog.ButtonFlags)
text	button's text

See also:: buttonText()

References QtxDialog.adjustButtons(), and QtxDialog.button().

void QtxDialog::setButtonFocus ( const int id ) [inherited]

Parameters:

id	control button ID (QtxDialog.ButtonFlags)

See also:: hasButtonFocus()

References QtxDialog.button().

bool QtxDialog::hasButtonFocus ( const int id ) const [inherited]

Parameters:

id	control button ID (QtxDialog.ButtonFlags)

Returns:: true if specified button has keyboard focus

See also:: setButtonFocus()

References QtxDialog.button().

bool QtxDialog::isButtonEnabled ( const int id ) const [inherited]

Parameters:

id	control button(s) ID (QtxDialog.ButtonFlags)

Returns:: true if all specified buttons are enabled.

See also:: setButtonEnabled()

References QtxDialog.buttons().

void QtxDialog::setButtonEnabled	(	const bool	on,
		const int	id
	)		`[inherited]`

Parameters:

on	enable button(s) flag
id	control button(s) ID (QtxDialog.ButtonFlags)

See also:: isButtonEnabled()

References QtxDialog.buttons().

bool QtxDialog::isBorderEnabled ( const int area ) const [inherited]

Parameters:

area	buttons area (QtxDialog.ButtonArea)

Returns:: true if border is enabled for specified button area.

See also:: setBorderEnabled()

References QtxDialog.myArea.

void QtxDialog::setBorderEnabled	(	const bool	on,
		const int	area
	)		`[inherited]`

Border is a line which separate main frame and control buttons.

Parameters:

area	buttons area (QtxDialog.ButtonArea)
on	enable border flag

See also:: isBorderEnabled()

References QtxDialog.isBorderEnabled(), and QtxDialog.myArea.

void QtxDialog::removeButton ( const int id ) [inherited]

If id is -1, all user buttons are removed.

Parameters:

id	user button ID

See also:: insertButton(), userButton(), userButtonIds()

References QtxDialog.myArea, QtxDialog.myButton, QtxDialog.myPosition, and QtxDialog.update().

int QtxDialog::insertButton	(	const QString &	text,
		const int	area = `BottomArea`
	)		`[inherited]`

The button is inserted to the specified dialog box area. if the button is added successfully, the unique identificator of the added button is returned, otherwise -1 is returned.

Parameters:

text	text of the added button
area	buttons area (QtxDialog.ButtonArea)

Returns:: button ID

See also:: removeButton(), userButton(), userButtonIds()

References QtxDialog.createButton(), QtxDialog.Area.insertButton(), QtxDialog.Left, QtxDialog.myArea, QtxDialog.myButton, QtxDialog.myPosition, QtxDialog.onButton(), QtxDialog.onDestroyed(), and QtxDialog.update().

QIntList QtxDialog::userButtonIds ( ) const [inherited]

Returns:: list of user buttons identificators

See also:: insertButton(), removeButton(), userButton()

References QtxDialog.myButton.

QAbstractButton * QtxDialog::userButton ( const int id ) const [inherited]

Parameters:

id	user button ID

Returns:: user button or 0 if it is not found

See also:: insertButton(), removeButton(), userButtonIds()

References QtxDialog.myButton.

uint QtxDialog::setAlignment ( uint align ) [inherited]

Use the function before the the dialog is first time shown. If dialog flag AlignOnce is set then alignment is performed only once, otherwise the dialog is aligned each time when it is shown. Dialog box is aligned relatively to its parent. By default, dialog box is aligned to the center of the parent widget (usually desktop or another dialog box).

Parameters:

align alignment flag(s) (Qtx.AlignmentFlags)

Returns:: previous alignment policy

References QtxDialog.myAlignment.

void QtxDialog::setUnits	(	QLabel *	aLabel,
		const QString &	aUnits
	)		`[static, inherited]`

In the dialog box label the measure units are closed in braces. If measure units do not exist they will be added.

For example:

  // create label "Radius"
  QLabel* aLabel = new QLabel( "Radius", mainFrame() );
  // set measure units to "mm"
  setUnits( aLabel, "mm" )    // => aLabel contains 'Radius (mm)'
  // set measure units to "cm"
  setUnits( aLabel, "cm" )    // => aLabel contains 'Radius (cm)'

  // create label "Radius" with initially not set measure units
  QLabel* aLabel = new QLabel( "Radius ():", mainFrame() );
  // set measure units to "mm"
  setUnits( aLabel, "mm" )    // => aLabel contains 'Radius (mm):'
  // set measure units to "cm"
  setUnits( aLabel, "cm" )    // => aLabel contains 'Radius (cm):'

Parameters:

aLabel	label widget
aUnits	measure units

void QtxDialog::dlgButton ( int id ) [signal, inherited]

Parameters:

id	user button identificator

void QtxDialog::dlgParamChanged ( ) [signal, inherited]

void QtxDialog::dlgHelp ( ) [signal, inherited]

void QtxDialog::dlgApply ( ) [signal, inherited]

void QtxDialog::dlgOk ( ) [signal, inherited]

void QtxDialog::dlgNo ( ) [signal, inherited]

void QtxDialog::dlgYes ( ) [signal, inherited]

void QtxDialog::dlgClose ( ) [signal, inherited]

void QtxDialog::dlgCancel ( ) [signal, inherited]

void QtxDialog::update ( ) [slot, inherited]

References QtxDialog.adjustButtons(), QtxDialog.myArea, QtxDialog.myButton, and QtxDialog.testButtonFlags().

QFrame * QtxDialog::mainFrame ( ) const [protected, inherited]

Main frame is an internal widget which should contains all elements of dialog box except control buttons.

Returns:: main frame widget

References QtxDialog.myMainFrame.

bool QtxDialog::acceptData ( ) const [protected, virtual, inherited]

This method can be re-implemented in the successor class if it requires to check user input consistency. Default implementation returns true.

This method is called if dialog flag QtxDialog.Accept is set. If this method returns true, then dialog will be accepted and closed.

Returns:: true if user input is valid

See also:: accept()

Reimplemented in QtxPathDialog.

bool QtxDialog::rejectData ( ) const [protected, virtual, inherited]

This method can be re-implemented in the successor class if it requires to check possibility to cancel dialog box safely. Default implementation returns true.

This method is called if dialog flag QtxDialog.Reject is set. If this method returns true, then dialog will be rejected and closed.

Returns:: true if dialog box can be cancelled

See also:: reject()

QAbstractButton * QtxDialog::createButton ( QWidget * parent ) [protected, virtual, inherited]

This method is invoked from method insertButton().

Parameters:

parent parent widget

Returns:: new user button

QAbstractButton * QtxDialog::button ( const int f ) const [protected, inherited]

Parameters:

f	control button ID (QtxDialog.ButtonFlags)

Returns:: button or 0 if id is invalid

References QtxDialog.myButton.

QtxDialog::ButtonMap QtxDialog::buttons ( const int f = All ) const [protected, inherited]

Parameters:

f	control button(s) ID(s) (QtxDialog.ButtonFlags)

Returns:: button map

References QtxDialog.myButton.

int QtxDialog::buttonId ( const QAbstractButton * b ) const [protected, inherited]

Parameters:

b button

Returns:: button ID

References QtxDialog.myButton.

void QtxDialog::showEvent ( QShowEvent * e ) [protected, virtual, inherited]

Re-implemented from Qt.

Parameters:

e	show event

References QtxDialog.AlignOnce, Qtx.alignWidget(), QtxDialog.myAlignment, QtxDialog.myInited, and QtxDialog.testDialogFlags().

void QtxDialog::hideEvent ( QHideEvent * e ) [protected, virtual, inherited]

Re-implemented from Qt.

Parameters:

e	hide event

void QtxDialog::closeEvent ( QCloseEvent * ) [protected, virtual, inherited]

Call reject() method.

Parameters:

e	close event (not used)

References QtxDialog.reject().

void QtxDialog::childEvent ( QChildEvent * e ) [protected, virtual, inherited]

Re-implemented from Qt.

Parameters:

e	child event

References QtxDialog.onSizeGripDestroyed().

void QtxDialog::keyPressEvent ( QKeyEvent * e ) [protected, virtual, inherited]

Re-implemented from Qt.

Call reject() if "Escape" key is pressed. Call accept() if "Ctrl+Enter" key-sequence is pressed. Process "F1" key and emit signal dlgHelp(). Transfer "Ctrl+(Shift+)Tab" key-sequence press event to the child Tab widget (if there is any).

Parameters: