te::qt::widgets::BasicStrokeDialog Class Reference

A dialog used to build a basic stroke element. If you want to use this dialog, you can use commands like: te::se::Stroke* s = te::qt::widgets::BasicStrokeDialog::getStroke(0, parent, "Title"); te::se::Stroke* s = te::qt::widgets::BasicStrokeDialog::getStroke(initialStroke, parent, "Title"); ... delete s; More...

#include <BasicStrokeDialog.h>

Inheritance diagram for te::qt::widgets::BasicStrokeDialog:

Initializer Methods

Methods related to instantiation and destruction.

std::unique_ptr< Ui::BasicStrokeDialogForm > m_ui
 Dialog form. More...
 
te::qt::widgets::BasicStrokeWidgetm_strokeWidget
 Basic Stroke Widget used to configure the stroke element. More...
 
 BasicStrokeDialog (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a basic stroke dialog which is a child of parent, with widget flags set to f. More...
 
 ~BasicStrokeDialog ()
 Destructor. More...
 
te::se::StrokegetStroke () const
 Gets the configured stroke element. More...
 
static te::se::StrokegetStroke (const te::se::Stroke *initial, QWidget *parent=0, const QString &title="")
 Pops up a modal basic stroke dialog with the given window title, lets the user configure the stroke, and returns that stroke. The stroke is initially set to initial. The dialog is a child of parent. More...
 

Detailed Description

A dialog used to build a basic stroke element. If you want to use this dialog, you can use commands like: te::se::Stroke* s = te::qt::widgets::BasicStrokeDialog::getStroke(0, parent, "Title"); te::se::Stroke* s = te::qt::widgets::BasicStrokeDialog::getStroke(initialStroke, parent, "Title"); ... delete s;

Definition at line 68 of file BasicStrokeDialog.h.

Constructor & Destructor Documentation

◆ BasicStrokeDialog()

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

Constructs a basic stroke dialog which is a child of parent, with widget flags set to f.

◆ ~BasicStrokeDialog()

te::qt::widgets::BasicStrokeDialog::~BasicStrokeDialog ( )

Destructor.

Member Function Documentation

◆ getStroke() [1/2]

te::se::Stroke* te::qt::widgets::BasicStrokeDialog::getStroke ( ) const

Gets the configured stroke element.

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

◆ getStroke() [2/2]

static te::se::Stroke* te::qt::widgets::BasicStrokeDialog::getStroke ( const te::se::Stroke initial,
QWidget *  parent = 0,
const QString &  title = "" 
)
static

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

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

Member Data Documentation

◆ m_strokeWidget

te::qt::widgets::BasicStrokeWidget* te::qt::widgets::BasicStrokeDialog::m_strokeWidget
private

Basic Stroke Widget used to configure the stroke element.

Definition at line 114 of file BasicStrokeDialog.h.

◆ m_ui

std::unique_ptr<Ui::BasicStrokeDialogForm> te::qt::widgets::BasicStrokeDialog::m_ui
private

Dialog form.

Definition at line 113 of file BasicStrokeDialog.h.


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