synthclone::FileSelectionView Class Reference

A utility view class that handles the selection of files and directories. More...

#include <synthclone/fileselectionview.h>

Inheritance diagram for synthclone::FileSelectionView:

Collaboration diagram for synthclone::FileSelectionView:

Public Types
enum	Operation { OPERATION_OPEN , OPERATION_SAVE }
	Specifies whether the view is being used to open or save a filesystem object. More...
enum	SelectionFilter { SELECTIONFILTER_ANY_FILE , SELECTIONFILTER_DIRECTORY , SELECTIONFILTER_EXISTING_FILE , SELECTIONFILTER_EXISTING_FILES }
	Specifies the types of filesystem objects the user may select. More...

Public Slots
void	setDirectory (const QString &directory)
	Sets the directory to be displayed.
void	setFilesVisible (bool visible)
	Sets a flag indicating whether or not to show files in the view.
void	setOperation (Operation operation)
	Sets the FileSelectionView::Operation for the view.
void	setSelectionFilter (SelectionFilter filter)
	Sets the FileSelectionView::SelectionFilter for this view.
void	setTitle (const QString &title)
	Sets the window title.
Public Slots inherited from synthclone::View
virtual void	setCloseEnabled (bool enabled)
	Enables/disables closing for this view.
virtual void	setVisible (bool visible)
	Sets the visibility of the root widget.

Signals
void	pathsSelected (const QStringList &paths)
	Emitted when the user selects a path or path(s).
Signals inherited from synthclone::View
void	closeEnabledChanged (bool enabled)
	Emitted when closing is enabled/disabled.
void	closeRequest ()
	Emitted when a root widget's close button is pressed.
void	visibilityChanged (bool visible)
	Emitted when the visibility flag for the view changes.

Public Member Functions
	FileSelectionView (QObject *parent=0)
	Constructs a new FileSelectionView object.
	~FileSelectionView ()
	Destroys a FileSelectionView object.
bool	areFilesVisible () const
	Gets a flag indicating whether or not files are visible in the view.
QString	getDirectory () const
	Gets the current displayed directory.
Operation	getOperation () const
	Gets the current FileSelectionView::Operation.
SelectionFilter	getSelectionFilter () const
	Gets the selection filter for this view.
QString	getTitle () const
	Gets the window title.
Public Member Functions inherited from synthclone::View
bool	isCloseEnabled () const
	Gets a boolean indicating whether or not closing of this view is enabled.
bool	isVisible () const
	Gets a boolean indicating whether or not the view is visible.

Additional Inherited Members
Protected Member Functions inherited from synthclone::View
	View (QWidget *rootWidget, QObject *parent=0)
	Constructs a new View.
virtual	~View ()
	Destroys the View object.
const QWidget *	getRootWidget () const
	Gets the root widget for this view.
QWidget *	getRootWidget ()
	Gets the root widget for this view.

Detailed Description

A utility view class that handles the selection of files and directories.

Note

The current implementation is a thin wrapper around QFileDialog.

Member Enumeration Documentation

Operation

enum synthclone::FileSelectionView::Operation

Specifies whether the view is being used to open or save a filesystem object.

Enumerator
OPERATION_OPEN
OPERATION_SAVE

SelectionFilter

enum synthclone::FileSelectionView::SelectionFilter

Specifies the types of filesystem objects the user may select.

Enumerator
SELECTIONFILTER_ANY_FILE
SELECTIONFILTER_DIRECTORY
SELECTIONFILTER_EXISTING_FILE
SELECTIONFILTER_EXISTING_FILES

Constructor & Destructor Documentation

FileSelectionView()

synthclone::FileSelectionView::FileSelectionView ( QObject *  parent = 0 )

explicit

Constructs a new FileSelectionView object.

Parameters

parent

The parent object of the FileSelectionView object.

~FileSelectionView()

synthclone::FileSelectionView::~FileSelectionView

(

)

Destroys a FileSelectionView object.

Member Function Documentation

areFilesVisible()

bool synthclone::FileSelectionView::areFilesVisible

(

)

const

Gets a flag indicating whether or not files are visible in the view.

Returns

The flag.

getDirectory()

QString synthclone::FileSelectionView::getDirectory

(

)

const

Gets the current displayed directory.

Returns

The current displayed directory.

getOperation()

Operation synthclone::FileSelectionView::getOperation

(

)

const

Gets the current FileSelectionView::Operation.

Returns

The current FileSelectionView::Operation.

getSelectionFilter()

SelectionFilter synthclone::FileSelectionView::getSelectionFilter

(

)

const

Gets the selection filter for this view.

Returns

The selection filter.

getTitle()

QString synthclone::FileSelectionView::getTitle

(

)

const

Gets the window title.

Returns

The window title.

pathsSelected

void synthclone::FileSelectionView::pathsSelected ( const QStringList &  paths )

signal

Emitted when the user selects a path or path(s).

Parameters

paths

The selected paths.

setDirectory

void synthclone::FileSelectionView::setDirectory ( const QString &  directory )

slot

Sets the directory to be displayed.

Parameters

directory

The directory.

setFilesVisible

void synthclone::FileSelectionView::setFilesVisible ( bool  visible )

slot

Sets a flag indicating whether or not to show files in the view.

If the 'visible' argument is set to false, then the selection filter will be set to FileSelectionView::SELECTIONFILTER_DIRECTORY when this method returns.

Parameters

visible

The flag.

setOperation

void synthclone::FileSelectionView::setOperation ( Operation  operation )

slot

Sets the FileSelectionView::Operation for the view.

Parameters

operation

The FileSelectionView::Operation.

setSelectionFilter

void synthclone::FileSelectionView::setSelectionFilter ( SelectionFilter  filter )

slot

Sets the FileSelectionView::SelectionFilter for this view.

Parameters

filter

The FileSelectionView::SelectionFilter.

setTitle

void synthclone::FileSelectionView::setTitle ( const QString &  title )

slot

Sets the window title.

Parameters

title

The title.

---

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

• fileselectionview.h