SBGWindowDialog Class Reference

This class is the base class of dialogs. More...

User interaction
	SB_DECLARE_DATA (SBGWindowDialog)
static void	informUser (const QString &dialogTitle, const QString &dialogText, const QPixmap &logo=QPixmap())
	Informs the user with a message in a modal pop-up dialog.
static void	informUser (const QString &dialogTitle, const QString &labelText, const QString &text, bool monospaceFont=false, const QPixmap &logo=QPixmap())
	Informs the user with a message and text in a modal pop-up dialog.
static void	informUser (SBGWindowWidget *widget, const QPixmap &logo=QPixmap())
	Informs the user with a widget in a modal pop-up dialog.
static void	informUser (QWidget *widget, const QPixmap &logo=QPixmap())
	Informs the user with a widget in a modal pop-up dialog.
static bool	askUser (const QString &dialogTitle, const QString &dialogText, QDialogButtonBox *buttonBox=nullptr, const QPixmap &logo=QPixmap())
	Asks a question to the user with a message in a modal pop-up dialog.
static bool	askUser (const QString &dialogTitle, const QString &labelText, const QString &text, bool monospaceFont=false, QDialogButtonBox *buttonBox=nullptr, const QPixmap &logo=QPixmap())
	Asks a question to the user with a message and text in a modal pop-up dialog.
static bool	askUser (SBGWindowWidget *widget, QDialogButtonBox *butons=nullptr, const QPixmap &logo=QPixmap())
	Asks a question to the user with a widget in a modal pop-up dialog.
static bool	askUser (QWidget *widget, QDialogButtonBox *butons=nullptr, const QPixmap &logo=QPixmap())
	Asks a question to the user with a widget in a modal pop-up dialog.
static bool	getChoiceFromUser (const QString &dialogTitle, int &resultIndex, const QString &label, const QStringList &choices, const QStringList &toolTips, const QList< QPixmap > &icons, const QPixmap &logo=QPixmap())
	Gets a choice from the user in a modal pop-up dialog.
static bool	getColorFromUser (const QString &dialogTitle, SBColor &result, const QPixmap &logo=QPixmap())
	Gets a color from the user in a modal pop-up dialog.
static bool	getDoubleFromUser (const QString &dialogTitle, double &result, double minimum, double maximum, double singleStep=1.0, const QString &prefix="", const QString &suffix="", int decimals=2, const QPixmap &logo=QPixmap())
	Gets a number from the user in a modal pop-up dialog.
static bool	getFontFromUser (const QString &dialogTitle, QFont &result, const QPixmap &logo=QPixmap())
	Gets a font from the user in a modal pop-up dialog.
static bool	getIntegerFromUser (const QString &dialogTitle, int &result, int minimum, int maximum, int singleStep=1, const QString &prefix="", const QString &suffix="", const QPixmap &logo=QPixmap())
	Gets a number from the user in a modal pop-up dialog.
static bool	getIntegerIntervalFromUser (const QString &dialogTitle, const QStringList &labelText, std::pair< int, int > &result, const std::pair< int, int > &minValueInterval, const std::pair< int, int > &maxValueInterval, const std::pair< int, int > &singleStep=std::pair< int, int >(1, 1), const QString &prefix="", const QString &suffix="", const QPixmap &logo=QPixmap())
	Gets an integer interval from the user in a modal pop-up dialog.
static bool	getDoubleIntervalFromUser (const QString &dialogTitle, const QStringList &labelText, std::pair< double, double > &result, const std::pair< double, double > &minValueInterval, const std::pair< double, double > &maxValueInterval, const std::pair< double, double > &singleStep=std::pair< double, double >(1.0, 1.0), const QString &prefix="", const QString &suffix="", const QPixmap &logo=QPixmap())
	Gets a double interval from the user in a modal pop-up dialog.
static bool	getStringFromUser (const QString &dialogTitle, QString &result, const QString &placeholderText="", const QPixmap &logo=QPixmap())
	Gets a string from the user in a modal pop-up dialog.
static bool	getPlainTextFromUser (const QString &dialogTitle, QString &result, int maxSize=0, const QString &placeholderText="", const QPixmap &logo=QPixmap())
	Gets a plain text from the user in a modal pop-up dialog.
static bool	getItemFromUser (const QString &dialogTitle, int &resultIndex, const QString &label, const QStringList &items, const QPixmap &logo=QPixmap())
	Gets an item from the user in a modal pop-up dialog.
static bool	getItemFromUser (const QString &dialogTitle, QString &result, const QString &label, const QStringList &items, int current=0, const QPixmap &logo=QPixmap())
	Gets an item from the user in a modal pop-up dialog.
static bool	getPromptFromUser (const QString &dialogTitle, QString &result, const QString &placeholderText="", const QPixmap &logo=QPixmap())
	Gets a string from the user in a modal pop-up dialog.
static bool	getPathFromUser (const QString &dialogTitle, QString &result, const QPixmap &logo=QPixmap())
	Gets a path from the user in a modal pop-up dialog.
static bool	getFileNameFromUser (const QString &dialogTitle, QString &result, const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=Q_NULLPTR, QFileDialog::Options options=QFileDialog::Options(), const QPixmap &logo=QPixmap())
	Gets a filename from the user in a modal pop-up dialog with Open button.
static bool	getFileNamesFromUser (const QString &dialogTitle, QStringList &result, const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=Q_NULLPTR, QFileDialog::Options options=QFileDialog::Options(), const QPixmap &logo=QPixmap())
	Gets a filename from the user in a modal pop-up dialog with Open button.
static bool	getSaveFileNameFromUser (const QString &dialogTitle, QString &result, const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=Q_NULLPTR, QFileDialog::Options options=QFileDialog::Options(), const QPixmap &logo=QPixmap())
	Gets a filename from the user in a modal pop-up dialog with Save button.
static bool	getCredentialsFromUser (const QString &dialogTitle, QString &user, QString &password, const QPixmap &logo=QPixmap())
	Gets credentials from the user in a modal pop-up dialog.
static bool	getCredentialsFromUser (const QString &dialogTitle, QString &host, int &port, QString &user, QString &password, const QPixmap &logo=QPixmap())
	Gets credentials from the user in a modal pop-up dialog.
static SBDPalette *	getPaletteFromUser (const QString &dialogTitle, bool &ok, const SBDPalette *defaultPalette=nullptr, const QPixmap &logo=QPixmap())
	Gets a color palette from the user in a modal pop-up dialog. If the defaultPalette is provided it is set as a default one in the color palette dialog.
static bool	getColorSchemeFromUser (const QString &dialogTitle, std::string &colorSchemeClassName, const SBDPalette *defaultPalette, SBDPalette *newPalette, const QPixmap &logo=QPixmap())
	Gets a color scheme and a color palette from the user in a modal pop-up dialog. If the defaultPalette is provided it is set as a default one in the dialog.
	SBGWindowDialog ()
void	hideEvent (QHideEvent *event)
void	showEvent (QShowEvent *event)

Constructor and destructor
virtual	~SBGWindowDialog ()
	Destructs the dialog.

Identity
virtual SBUUID	getUUID () const
	Returns the dialog UUID.
virtual QString	getName () const
	Returns the dialog name (used as a title for the embedding window)
virtual QPixmap	getLogo () const
	Returns the dialog logo.
virtual int	getFormat () const
	Returns the dialog format.

Embedding window
SBGWindow *	getWindow () const
	Returns the pointer to the embedding window.

Settings
virtual void	loadSettings (SBGSettings *settings)
	Loads the dialog settings.
virtual void	saveSettings (SBGSettings *settings)
	Saves the dialog settings.
void	loadDefaultSettings ()
	Loads the dialog's default settings.
void	saveDefaultSettings ()
	Saves the dialog's default settings.

Detailed Description

This class is the base class of dialogs in the SAMSON GUI. SAMSON Extension do not create instances of this class, but of classes that derive from this class. In order for a dialog to have the SAMSON interface style, the dialog is embedded in a window.

See also

SBGWindow

SBGWindowWidget

Member Function Documentation

askUser() [1/4]

bool SBGWindowDialog::askUser ( const QString &  dialogTitle, const QString &  dialogText, QDialogButtonBox *  buttonBox = nullptr, const QPixmap &  logo = QPixmap()  )

static

This static function asks the user a question with a message in a modal pop-up dialog. This is a convenience function which makes it easy to program questions to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the Cancel button or the OK button. The function returns true if the user presses the OK button, or false if the user presses the Cancel button or closes the dialog.

bool userReply = SBGWindowDialog::askUser("Information", "This operation will be 
    applied to all atoms in the document. Would you like to continue?");

See also

informUser

askUser() [2/4]

bool SBGWindowDialog::askUser ( const QString &  dialogTitle, const QString &  labelText, const QString &  text, bool  monospaceFont = false, QDialogButtonBox *  buttonBox = nullptr, const QPixmap &  logo = QPixmap()  )

static

This static function asks the user a question with a message and text in a modal pop-up dialog. This is a convenience function which makes it easy to program questions to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the Cancel button or the OK button. The function returns true if the user presses the OK button, or false if the user presses the Cancel button or closes the dialog.

bool userReply = SBGWindowDialog::askUser("Information", "This operation produced the following warnings. Would you like to continue?", "Log text here");

See also

informUser

askUser() [3/4]

bool SBGWindowDialog::askUser ( QWidget *  widget, QDialogButtonBox *  buttonBox = nullptr, const QPixmap &  logo = QPixmap()  )

static

This static function asks the user a question with a widget in a modal pop-up dialog. This is a convenience function which makes it easy to program questions to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the Cancel button or the OK button. The function returns true if the user presses the OK button, or false if the user presses the Cancel button or closes the dialog. The dialog title and icon are taken from the widget. Note that the OK button and the Cancel button are created by this function, and the widget does not have to contain some.

// MyCustomWidget derives from QWidget
QWidget* myCustomWidget = new QWidget();
bool userReply = SBGWindowDialog::askUser(myCustomWidget);
 
// do something based on the user reply
...
 
delete myCustomWidget;

See also

informUser

askUser() [4/4]

bool SBGWindowDialog::askUser ( SBGWindowWidget *  widget, QDialogButtonBox *  buttonBox = nullptr, const QPixmap &  logo = QPixmap()  )

static

This static function asks the user a question with a widget in a modal pop-up dialog. This is a convenience function which makes it easy to program questions to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the Cancel button or the OK button. The function returns true if the user presses the OK button, or false if the user presses the Cancel button or closes the dialog. The dialog title and icon are taken from the widget. Note that the OK button and the Cancel button are created by this function, and the widget does not have to contain some.

// MyCustomWidget derives from SBGWindowWidget
MyCustomWidget* myCustomWidget = new MyCustomWidget();
bool userReply = SBGWindowDialog::askUser(myCustomWidget);
 
// do something based on the user reply
...
 
delete myCustomWidget;

See also

informUser

informUser() [1/4]

void SBGWindowDialog::informUser ( const QString &  dialogTitle, const QString &  dialogText, const QPixmap &  logo = QPixmap()  )

static

This static function informs the user with a message in a modal pop-up dialog. This is a convenience function which makes it easy to program messages to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the OK button.

SBGWindowDialog::informUser("Information", "This operation will be applied to 
all atoms in the document.");

See also

askUser

informUser() [2/4]

void SBGWindowDialog::informUser ( const QString &  dialogTitle, const QString &  labelText, const QString &  text, bool  monospaceFont = false, const QPixmap &  logo = QPixmap()  )

static

This static function informs the user with a message and text in a modal pop-up dialog. This is a convenience function which makes it easy to program messages with logs to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the OK button.

SBGWindowDialog::informUser("Information", "This operation produced the following log:", "Log text here");

See also

askUser

informUser() [3/4]

void SBGWindowDialog::informUser ( QWidget *  widget, const QPixmap &  logo = QPixmap()  )

static

This static function informs the user with a widget in a modal pop-up dialog. This is a convenience function which makes it easy to program messages to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the OK button. The dialog title and icon are taken from the widget. Note that the OK button is created by this function, and the widget does not have to contain one.

// MyCustomWidget derives from SBGWindowWidget
QWidget* myCustomWidget = new QWidget();
SBGWindowDialog::informUser(myCustomWidget);
delete myCustomWidget;

See also

askUser

informUser() [4/4]

void SBGWindowDialog::informUser ( SBGWindowWidget *  widget, const QPixmap &  logo = QPixmap()  )

static

This static function informs the user with a widget in a modal pop-up dialog. This is a convenience function which makes it easy to program messages to the user with the SAMSON style. The function creates a modal pop-up dialog that blocks all other user interaction until the user pushes the OK button. The dialog title and icon are taken from the widget. Note that the OK button is created by this function, and the widget does not have to contain one.

// MyCustomWidget derives from SBGWindowWidget
MyCustomWidget* myCustomWidget = new MyCustomWidget();
SBGWindowDialog::informUser(myCustomWidget);
delete myCustomWidget;

See also

askUser