Class SBGWidgetFolderSelector#

ClassList > SBGWidgetFolderSelector

#include <SBGWidgetFolderSelector.hpp>

Inherits the following classes: QWidget

Public Slots#

Type	Name
slot void	onBrowse

Public Signals#

Type	Name
signal void	pathChanged

Public Functions#

Type	Name
	SBGWidgetFolderSelector (QWidget * parent=nullptr) Constructs a path selector widget.
QString	getFolderPath () Returns the path.
QString	getLabel () const Returns the label shown in the selector.
void	setFolderPath (const QString & path) Sets the path.
void	setLabel (const QString & label) Sets the label shown in the selector.
virtual	~SBGWidgetFolderSelector () Destructs the path selector widget.

Public Static Functions#

Type	Name
bool	checkFolder (const QString & path, bool askUser) Check whether the directory is correct.
bool	createChildFolder (QString & childPath, const QString & path, const QString & suffix, bool withTimeStamp) Create a child directory.

Detailed Description#

The SBGWidgetFolderSelector class is a convenience widget for specifying a folder path - it contains a label, a line edit and a push button to browse for a folder.

Short name: SBFolderSelector

Public Slots Documentation#

slot onBrowse#

void onBrowse;

Public Signals Documentation#

signal pathChanged#

void pathChanged;

Public Functions Documentation#

function SBGWidgetFolderSelector#

Constructs a path selector widget.

SBGWidgetFolderSelector::SBGWidgetFolderSelector (
    QWidget * parent=nullptr
)

function getFolderPath#

Returns the path.

QString SBGWidgetFolderSelector::getFolderPath ()

function getLabel#

Returns the label shown in the selector.

QString SBGWidgetFolderSelector::getLabel () const

function setFolderPath#

Sets the path.

void SBGWidgetFolderSelector::setFolderPath (
    const QString & path
)

function setLabel#

Sets the label shown in the selector.

void SBGWidgetFolderSelector::setLabel (
    const QString & label
)

function ~SBGWidgetFolderSelector#

Destructs the path selector widget.

virtual SBGWidgetFolderSelector::~SBGWidgetFolderSelector ()

Public Static Functions Documentation#

function checkFolder#

Check whether the directory is correct.

static bool SBGWidgetFolderSelector::checkFolder (
    const QString & path,
    bool askUser
)

function createChildFolder#

Create a child directory.

static bool SBGWidgetFolderSelector::createChildFolder (
    QString & childPath,
    const QString & path,
    const QString & suffix,
    bool withTimeStamp
)