te::qt::widgets::WellKnownMarkDialog Class Reference

A dialog used to build a well known mark element. If you want to use this dialog, you can use commands like: te::se::Mark* m = te::qt::widgets::MarkDialog::getMark(0, parent, "Title"); te::se::Mark* m = te::qt::widgets::MarkDialog::getMark(initialMark, parent, "Title"); ... delete m; More...

#include <WellKnownMarkDialog.h>

Inheritance diagram for te::qt::widgets::WellKnownMarkDialog:

Initializer Methods

Methods related to instantiation and destruction.

std::unique_ptr< Ui::WellKnownMarkDialogForm > m_ui
 Dialog form. More...
 
te::qt::widgets::WellKnownMarkWidgetm_markWidget
 Well Known Mark Widget used to configure the mak element. More...
 
 WellKnownMarkDialog (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a well known mark dialog which is a child of parent, with widget flags set to f. More...
 
 ~WellKnownMarkDialog ()
 Destructor. More...
 
te::se::MarkgetMark () const
 Gets the configured mark element. More...
 
static te::se::MarkgetMark (const te::se::Mark *initial, QWidget *parent=0, const QString &title="")
 Pops up a modal mark dialog with the given window title, lets the user configure the mark, and returns that mark. The mark is initially set to initial. The dialog is a child of parent. More...
 

Detailed Description

A dialog used to build a well known mark element. If you want to use this dialog, you can use commands like: te::se::Mark* m = te::qt::widgets::MarkDialog::getMark(0, parent, "Title"); te::se::Mark* m = te::qt::widgets::MarkDialog::getMark(initialMark, parent, "Title"); ... delete m;

Definition at line 70 of file WellKnownMarkDialog.h.

Constructor & Destructor Documentation

◆ WellKnownMarkDialog()

te::qt::widgets::WellKnownMarkDialog::WellKnownMarkDialog ( QWidget *  parent = 0,
Qt::WindowFlags  f = 0 
)

Constructs a well known mark dialog which is a child of parent, with widget flags set to f.

◆ ~WellKnownMarkDialog()

te::qt::widgets::WellKnownMarkDialog::~WellKnownMarkDialog ( )

Destructor.

Member Function Documentation

◆ getMark() [1/2]

te::se::Mark* te::qt::widgets::WellKnownMarkDialog::getMark ( ) const

Gets the configured mark element.

Returns
The configured mark element.
Note
The caller will take the ownership of the returned mark.

◆ getMark() [2/2]

static te::se::Mark* te::qt::widgets::WellKnownMarkDialog::getMark ( const te::se::Mark initial,
QWidget *  parent = 0,
const QString &  title = "" 
)
static

Pops up a modal mark dialog with the given window title, lets the user configure the mark, and returns that mark. The mark is initially set to initial. The dialog is a child of parent.

Parameters
initialA initial mark element that will be used. The dialog form will be update based on mark element parameters. It can be NULL.
parentDialog parent.
titleDialog title.
Note
The dialog will NOT take the ownership of the given initial mark.
The caller will take the ownership of the returned mark.
It returns a NULL mark element if the user cancels the dialog.

Member Data Documentation

◆ m_markWidget

te::qt::widgets::WellKnownMarkWidget* te::qt::widgets::WellKnownMarkDialog::m_markWidget
private

Well Known Mark Widget used to configure the mak element.

Definition at line 116 of file WellKnownMarkDialog.h.

◆ m_ui

std::unique_ptr<Ui::WellKnownMarkDialogForm> te::qt::widgets::WellKnownMarkDialog::m_ui
private

Dialog form.

Definition at line 115 of file WellKnownMarkDialog.h.


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