Dialog for specifying of point marker parameters. More...

#include <VTKViewer_MarkerDlg.h>

Inheritance diagram for VTKViewer_MarkerDlg:

Public Member Functions
	VTKViewer_MarkerDlg (QWidget *=0)
	Constructor. More...

virtual	~VTKViewer_MarkerDlg ()
	Destructor. More...

void	setHelpData (const QString &theModuleName, const QString &theHelpFileName)
	Associate documentation page with the dialog box. More...

void	setCustomMarkers (const VTK::MarkerMap &)
	Set custom markers data. More...

VTK::MarkerMap	customMarkers () const
	Get custom markers data. More...

void	addMarker (VTK::MarkerType, const QPixmap &)
	Add standard marker The marker type specified with type must be > VTK::MT_USER. More...

void	setMarker (VTK::MarkerType, VTK::MarkerScale)
	Select specified standard marker as current one. More...

void	setCustomMarker (int)
	Select specified custom marker as current one. More...

VTK::MarkerType	markerType () const
	Get current marker's type. For custom marker, VTK::MT_USER is returned and markerId() function then returns its identifier. More...

VTK::MarkerScale	markerScale () const
	Get current marker's scale size. For custom marker return value is undefined. More...

int	markerId () const

Public Member Functions inherited from QtxDialog
	QtxDialog (QWidget *=0, bool=false, bool=false, const int=Standard, Qt::WindowFlags=0)
	Constructor. More...

virtual	~QtxDialog ()
	Destructor. More...

void	setDialogFlags (const int)
	Set specified dialog box flags. More...

void	clearDialogFlags (const int)
	Clear specified the dialog flags. More...

bool	testDialogFlags (const int) const
	Test specified dialog flags. More...

void	setButtonFlags (const int)
	Add specified control button(s) to the dialog box. More...

void	clearButtonFlags (const int)
	Remove specified control button(s) from the dialog box. More...

bool	testButtonFlags (const int) const
	Test specified buttons. More...

int	buttonPosition (const int) const
	Get specified control button position. More...

void	setButtonPosition (const int, const int=-1)
	Set the specified control button(s) position. More...

void	setPlacePosition (const int, const int)
	Set button position for all buttons in specified area. More...

int	placePolicy (const int) const
	Get buttons layouting policy for the specified area. More...

void	setPlacePolicy (const int, const int)
	set buttons layouting policy for the specified area. More...

void	setButtonPlace (const int, const int)
	Move specified button(s) into specified area. More...

QString	buttonText (const int)
	Get specified button's text. More...

void	setButtonText (const int, const QString &text)
	Set specified button's text. More...

void	setButtonFocus (const int)
	Sets the keyboard focus to the specified button. More...

bool	hasButtonFocus (const int) const
	Check if specified button has keyboard focus. More...

bool	isButtonEnabled (const int) const
	Get "enabled" status of the specified button(s). More...

void	setButtonEnabled (const bool, const int)
	Enable/disable specified button(s). More...

bool	isBorderEnabled (const int) const
	Check if border is enabled. More...

void	setBorderEnabled (const bool, const int)
	Show/hide border for the specified button area. More...

void	removeButton (const int)
	Remove user button. More...

int	insertButton (const QString &, const int=BottomArea)
	Add user button to the dialog box. More...

QIntList	userButtonIds () const
	Get all user button IDs. More...

QAbstractButton *	userButton (const int) const
	Get user button by the specified id. More...

uint	setAlignment (uint align)
	Sets alignment policy. More...

Protected Member Functions
void	keyPressEvent (QKeyEvent *)
	Process key press event. More...

Protected Member Functions inherited from QtxDialog
QFrame *	mainFrame () const
	Get dialog box main frame widget. More...

virtual bool	acceptData () const
	Check if data entered by the user is valid. More...

virtual bool	rejectData () const
	Check if dialog box can be cancelled. More...

virtual QAbstractButton *	createButton (QWidget *)
	Create new user button. More...

QAbstractButton *	button (const int) const
	Get button by the specified ID. More...

ButtonMap	buttons (const int=All) const
	Get buttons by the specified IDs. More...

int	buttonId (const QAbstractButton *) const
	Get specified button's identifier. More...

int	buttonPosition (QAbstractButton *) const
	Get position of specified button. More...

virtual void	showEvent (QShowEvent *)
	Align this dialog according to the parent widget and alignment policy before the dialog box is shown. More...

virtual void	hideEvent (QHideEvent *)
	Process all existing events when dialog box is hidden. More...

virtual void	closeEvent (QCloseEvent *)
	Called when user closes dialog box. More...

virtual void	childEvent (QChildEvent *)
	Update dialog box layout when the size grip is added. More...

Private Slots
void	onHelp ()
	Activate help for the dialog box. More...

Private Attributes
VTKViewer_MarkerWidget *	myMarkerWidget

QString	myModule

QString	myHelpFile

Additional Inherited Members
Public Types inherited from QtxDialog
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 inherited from QtxDialog
void	update ()
	Update dialog box. More...

virtual void	setVisible (bool)
	Show/hide dialog box, set keyboard focus to the dialog. More...

Signals inherited from QtxDialog
void	dlgButton (int)
	Emitted when the user button is clicked. More...

void	dlgParamChanged ()
	This signal can be used in successor classes to signalize about some dialog parameter changing. More...

void	dlgHelp ()
	Emitted when the "Help" button is clicked. More...

void	dlgApply ()
	Emitted when the "Apply" button is clicked. More...

void	dlgOk ()
	Emitted when the "OK" button is clicked. More...

void	dlgNo ()
	Emitted when the "No" button is clicked. More...

void	dlgYes ()
	Emitted when the "Yes" button is clicked. More...

void	dlgClose ()
	Emitted when the "Close" button is clicked. More...

void	dlgCancel ()
	Emitted when the "Cancel" button is clicked. More...

Static Public Member Functions inherited from QtxDialog
static void	setUnits (QLabel *, const QString &)
	Set measure units to the specified label. More...

Protected Types inherited from QtxDialog
typedef QMap< int, QAbstractButton * >	ButtonMap
	button map More...

Protected Slots inherited from QtxDialog
virtual void	accept ()
	Accept the dialog box. More...

virtual void	reject ()
	Reject the dialog box. More...

Detailed Description

Dialog for specifying of point marker parameters.

Constructor & Destructor Documentation

◆ VTKViewer_MarkerDlg()

VTKViewer_MarkerDlg::VTKViewer_MarkerDlg ( QWidget * parent = 0 )

Constructor.

Parameters

parent parent widget

References QtxDialog::dlgHelp(), QtxDialog::mainFrame(), myMarkerWidget, and onHelp().

◆ ~VTKViewer_MarkerDlg()

VTKViewer_MarkerDlg::~VTKViewer_MarkerDlg ( )

virtual

Destructor.

Member Function Documentation

◆ addMarker()

void VTKViewer_MarkerDlg::addMarker	(	VTK::MarkerType	type,
		const QPixmap &	icon
	)

Add standard marker The marker type specified with type must be > VTK::MT_USER.

Parameters

type	marker type
icon	marker icon

References VTKViewer_MarkerWidget::addMarker(), and myMarkerWidget.

◆ customMarkers()

VTK::MarkerMap VTKViewer_MarkerDlg::customMarkers ( ) const

Get custom markers data.

Returns: custom marker data

References VTKViewer_MarkerWidget::customMarkers(), and myMarkerWidget.

◆ keyPressEvent()

void VTKViewer_MarkerDlg::keyPressEvent ( QKeyEvent * e )

protectedvirtual

Process key press event.

Parameters

e	key press event

Reimplemented from QtxDialog.

References QtxDialog::keyPressEvent(), and onHelp().

◆ markerId()

int VTKViewer_MarkerDlg::markerId ( ) const

\bried Get currently selected custom marker's identifier. For standard markers return value is VTK::MT_NONE.

References VTKViewer_MarkerWidget::markerId(), and myMarkerWidget.

◆ markerScale()

VTK::MarkerScale VTKViewer_MarkerDlg::markerScale ( ) const

Get current marker's scale size. For custom marker return value is undefined.

Returns: currently selected marker scale size

References VTKViewer_MarkerWidget::markerScale(), and myMarkerWidget.

◆ markerType()

VTK::MarkerType VTKViewer_MarkerDlg::markerType ( ) const

Get current marker's type. For custom marker, VTK::MT_USER is returned and markerId() function then returns its identifier.

Returns: currently selected marker type

References VTKViewer_MarkerWidget::markerType(), and myMarkerWidget.

◆ onHelp

void VTKViewer_MarkerDlg::onHelp ( )

privateslot

Activate help for the dialog box.

References SUIT_Session::activeApplication(), myHelpFile, myModule, SUIT_Application::onHelpContextModule(), and SUIT_Session::session().

◆ setCustomMarker()

void VTKViewer_MarkerDlg::setCustomMarker ( int id )

Select specified custom marker as current one.

Parameters

id	custom marker identifier

References myMarkerWidget, and VTKViewer_MarkerWidget::setCustomMarker().

◆ setCustomMarkers()

void VTKViewer_MarkerDlg::setCustomMarkers ( const VTK::MarkerMap & markerMap )

Set custom markers data.

Parameters

markerMap custom marker data (a map {index:texture})

References myMarkerWidget, and VTKViewer_MarkerWidget::setCustomMarkers().

◆ setHelpData()

void VTKViewer_MarkerDlg::setHelpData	(	const QString &	module,
		const QString &	helpFile
	)

Associate documentation page with the dialog box.

Parameters

module	module name
helpFile	reference help file

References myHelpFile, and myModule.

◆ setMarker()

void VTKViewer_MarkerDlg::setMarker	(	VTK::MarkerType	type,
		VTK::MarkerScale	scale
	)

Select specified standard marker as current one.

Parameters

type	marker type
scale	marker scale (optional parameter; can be omitted for extended markers)

References myMarkerWidget, and VTKViewer_MarkerWidget::setMarker().

Member Data Documentation

◆ myHelpFile

QString VTKViewer_MarkerDlg::myHelpFile

private

◆ myMarkerWidget

VTKViewer_MarkerWidget* VTKViewer_MarkerDlg::myMarkerWidget

private

◆ myModule

QString VTKViewer_MarkerDlg::myModule

private

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

src/VTKViewer/VTKViewer_MarkerDlg.h
src/VTKViewer/VTKViewer_MarkerDlg.cxx

Public Member Functions

Protected Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VTKViewer_MarkerDlg()

◆ ~VTKViewer_MarkerDlg()

Member Function Documentation

◆ addMarker()

◆ customMarkers()

◆ keyPressEvent()

◆ markerId()

◆ markerScale()

◆ markerType()

◆ onHelp

◆ setCustomMarker()

◆ setCustomMarkers()

◆ setHelpData()

◆ setMarker()

Member Data Documentation

◆ myHelpFile

◆ myMarkerWidget

◆ myModule