TGUI  0.9.1

File dialog widget. More...

#include <TGUI/Widgets/FileDialog.hpp>

Inheritance diagram for tgui::FileDialog:
tgui::ChildWindow tgui::Container tgui::Widget

Public Types

typedef std::shared_ptr< FileDialogPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const FileDialogConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ChildWindow
enum class  TitleAlignment { Left , Center , Right }
 Title alignments, possible options for the setTitleAlignment function. More...
 
enum  TitleButton { None = 0 , Close = 1 << 0 , Maximize = 1 << 1 , Minimize = 1 << 2 }
 Title buttons (use bitwise OR to combine) More...
 
typedef std::shared_ptr< ChildWindowPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ChildWindowConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
typedef std::shared_ptr< ContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 FileDialog (const FileDialog &copy)
 Copy constructor.
 
 FileDialog (FileDialog &&copy) noexcept
 Move constructor.
 
FileDialogoperator= (const FileDialog &right)
 Overload of copy assignment operator.
 
FileDialogoperator= (FileDialog &&right) noexcept
 Overload of move assignment operator.
 
FileDialogRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
FileDialogRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const std::vector< Filesystem::Path > & getSelectedPaths () const
 Returns the selected files/directories. More...
 
void setPath (const String &path)
 Changes the directory for which the files are to be displayed. More...
 
void setPath (const Filesystem::Path &path)
 Changes the directory for which the files are to be displayed. More...
 
const Filesystem::PathgetPath () const
 Returns the directory that is currently being shown in the file dialog. More...
 
void setFilename (const String &filename)
 Sets the filename that is shown at the bottom of the file dialog. More...
 
const StringgetFilename () const
 Returns the filename that is entered in the filename edit box. More...
 
void setFileTypeFilters (const std::vector< std::pair< String, std::vector< String >>> &filters, std::size_t defaultFilterIndex=0)
 Changes the file filters which the user can select to only show files of a certain type. More...
 
const std::vector< std::pair< String, std::vector< String > > > & getFileTypeFilters () const
 Returns the file filters which the user can select to only show files of a certain type. More...
 
std::size_t getFileTypeFiltersIndex () const
 Returns the index of the currently selected file filter. More...
 
void setConfirmButtonText (const String &text="Open")
 Changes the text of the open/save button. More...
 
const StringgetConfirmButtonText () const
 Return the text of the open/save button. More...
 
void setCancelButtonText (const String &text="Cancel")
 Changes the text of the cancel button (e.g. to display it in a different language) More...
 
const StringgetCancelButtonText () const
 Return the text of the cancel button. More...
 
void setFilenameLabelText (const String &labelText="Filename:")
 Changes the text of the filename label (e.g. to display it in a different language) More...
 
const StringgetFilenameLabelText () const
 Return the text of the filename label. More...
 
void setListViewColumnCaptions (const String &nameColumnText="Name", const String &sizeColumnText="Size", const String &modifiedColumnText="Modified")
 Changes the names of the list view columns (e.g. to display them in a different language) More...
 
std::tuple< String, String, StringgetListViewColumnCaptions () const
 Returns the names of the list view columns. More...
 
void setFileMustExist (bool enforceExistence)
 Changes whether the file should exist or whether the filename can be a non-existent file. More...
 
bool getFileMustExist () const
 Returns whether the file should exist or whether the filename can be a non-existent file. More...
 
void setSelectingDirectory (bool selectDirectories)
 Changes whether the file dialog is used for selecting a file or for selecting a directory. More...
 
bool getSelectingDirectory () const
 Returns whether the file dialog is used for selecting a file or for selecting a directory. More...
 
void setMultiSelect (bool multiSelect)
 Changes whether multiple files can be selected. More...
 
bool getMultiSelect () const
 Returns whether multiple files can be selected. More...
 
void setIconLoader (std::shared_ptr< FileDialogIconLoader > iconLoader)
 Sets a custom icon loader. More...
 
std::shared_ptr< FileDialogIconLoadergetIconLoader () const
 Gets the icon loader that is currently being used. More...
 
- Public Member Functions inherited from tgui::ChildWindow
ChildWindowRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ChildWindowRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (const Layout2d &position) override
 Sets the position of the widget. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the child window. More...
 
Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container. More...
 
void setClientSize (Vector2f size)
 Changes the client size of the child window. More...
 
Vector2f getClientSize () const
 Returns the client size of the child window. More...
 
void setMaximumSize (Vector2f size)
 Sets the maximum size of the child window. More...
 
Vector2f getMaximumSize () const
 Returns the maximum size of the child window. More...
 
void setMinimumSize (Vector2f size)
 Sets the minimum size of the child window. More...
 
Vector2f getMinimumSize () const
 Returns the minimum size of the child window. More...
 
void setTitle (const String &title)
 Changes the title that is displayed in the title bar of the child window. More...
 
const StringgetTitle () const
 Returns the title that is displayed in the title bar of the child window. More...
 
void setTitleTextSize (unsigned int size)
 Changes the character size of the title. More...
 
unsigned int getTitleTextSize () const
 Returns the character size of the title. More...
 
void setTitleAlignment (TitleAlignment alignment)
 Changes the title alignment. More...
 
TitleAlignment getTitleAlignment () const
 Returns the title alignment. More...
 
void setTitleButtons (unsigned int buttons)
 Changes the title buttons. More...
 
unsigned int getTitleButtons () const
 Returns the title bar buttons. More...
 
void close ()
 Try to close the window. More...
 
void destroy ()
 Closes the window. More...
 
void setResizable (bool resizable=true)
 Changes whether the child window can be resized by dragging its borders or not. More...
 
bool isResizable () const
 Checks whether the child window can be resized by dragging its borders or not. More...
 
void setPositionLocked (bool positionLocked=true)
 Changes whether the child window can be moved by dragging its title bar or not. More...
 
bool isPositionLocked () const
 Checks whether the child window can be moved by dragging its title bar or not. More...
 
void setKeepInParent (bool enabled=true)
 Sets the child window to be kept inside its parent. More...
 
bool isKeptInParent () const
 Tells whether the child window is kept inside its parent. More...
 
Vector2f getChildWidgetsOffset () const override
 Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0). More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor.
 
 Container (Container &&copy) noexcept
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right) noexcept
 Overload of move assignment operator.
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets in this container. More...
 
template<typename Function >
void sortWidgets (Function &&function)
 Sorts a list of all the widgets in this container. More...
 
virtual void add (const Widget::Ptr &widgetPtr, const String &widgetName="")
 Adds a widget to the container. More...
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier. More...
 
virtual bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
void setTextSize (unsigned int size) override
 Changes the character size of all existing and future child widgets. More...
 
void loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const String &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream) const
 Saves the child widgets to a text file. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets, to the front of the z-order. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets, to the back of the z-order. More...
 
std::size_t moveWidgetForward (const Widget::Ptr &widget)
 Places a widget one step forward in the z-order. More...
 
std::size_t moveWidgetBackward (const Widget::Ptr &widget)
 Places a widget one step backward in the z-order. More...
 
Widget::Ptr getFocusedChild () const
 Returns the child widget that is focused inside this container. More...
 
Widget::Ptr getFocusedLeaf () const
 Returns the leaf child widget that is focused inside this container. More...
 
virtual Widget::Ptr getWidgetAtPosition (Vector2f pos) const
 Returns the leaf child widget that is located at the given position. More...
 
bool focusNextWidget (bool recursive=true)
 Focuses the next widget in this container. More...
 
bool focusPreviousWidget (bool recursive=true)
 Focuses the previous widget in this container. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
bool processMouseMoveEvent (Vector2f pos)
 Inform the container about a mouse move event. More...
 
bool processMousePressEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse press event. More...
 
bool processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse release event. More...
 
bool processMouseWheelScrollEvent (float delta, Vector2f pos)
 Inform the container about a mouse wheel scroll event. More...
 
bool processKeyPressEvent (Event::KeyEvent event)
 Inform the container about a key press event. More...
 
bool processTextEnteredEvent (char32_t key)
 Inform the container about a key press event. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
GuiBasegetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Static Public Member Functions

static FileDialog::Ptr create (String title="Open file", String confirmButtonText="Open")
 Creates a new file dialog widget. More...
 
static FileDialog::Ptr copy (FileDialog::ConstPtr dialog)
 Makes a copy of another file dialog. More...
 
- Static Public Member Functions inherited from tgui::ChildWindow
static ChildWindow::Ptr create (const String &title="", unsigned int titleButtons=TitleButton::Close)
 Creates a new child window widget. More...
 
static ChildWindow::Ptr copy (ChildWindow::ConstPtr childWindow)
 Makes a copy of another child window. More...
 

Public Attributes

SignalPathList onFileSelect = {"FileSelected"}
 
- Public Attributes inherited from tgui::ChildWindow
Signal onMousePress = {"MousePressed"}
 The mouse went down on the widget.
 
SignalChildWindow onClose = {"Closed"}
 The window was closed. Optional parameter: pointer to the window.
 
SignalChildWindow onMinimize = {"Minimized"}
 The window was minimized. Optional parameter: pointer to the window.
 
SignalChildWindow onMaximize = {"Maximized"}
 The window was maximized. Optional parameter: pointer to the window.
 
SignalChildWindow onEscapeKeyPress = {"EscapeKeyPressed"}
 The escape key was pressed while the child window was focused. Optional parameter: pointer to the window.
 
SignalTyped< bool * > onClosing = {"Closing"}
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::ChildWindow
void mouseEnteredWidget () override
 This function is called when the mouse enters the widget.
 
void mouseLeftWidget () override
 This function is called when the mouse leaves the widget.
 

Detailed Description

File dialog widget.

Open dialog:

auto openFileDialog = tgui::FileDialog::create("Open file", "Open");
static FileDialog::Ptr create(String title="Open file", String confirmButtonText="Open")
Creates a new file dialog widget.

Save dialog:

auto saveFileDialog = tgui::FileDialog::create("Save file", "Save");
saveFileDialog->setFileMustExist(false);

Member Function Documentation

◆ clone()

Widget::Ptr tgui::FileDialog::clone ( ) const
inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Reimplemented from tgui::ChildWindow.

◆ copy()

static FileDialog::Ptr tgui::FileDialog::copy ( FileDialog::ConstPtr  dialog)
static

Makes a copy of another file dialog.

Parameters
dialogThe other file dialog
Returns
The new file dialog

◆ create()

static FileDialog::Ptr tgui::FileDialog::create ( String  title = "Open file",
String  confirmButtonText = "Open" 
)
static

Creates a new file dialog widget.

Parameters
titleTitle to display in the title bar of the file dialog
confirmButtonTextCaption of the open/save button
Returns
The new file dialog

◆ getCancelButtonText()

const String& tgui::FileDialog::getCancelButtonText ( ) const

Return the text of the cancel button.

Returns
Current caption of the cancel button

◆ getConfirmButtonText()

const String& tgui::FileDialog::getConfirmButtonText ( ) const

Return the text of the open/save button.

Returns
Current caption of the open/save button

◆ getFileMustExist()

bool tgui::FileDialog::getFileMustExist ( ) const

Returns whether the file should exist or whether the filename can be a non-existent file.

Returns
Should the open/save button be disabled when the filename doesn't exist?

◆ getFilename()

const String& tgui::FileDialog::getFilename ( ) const

Returns the filename that is entered in the filename edit box.

Returns
Text entered in the filename edit box

Note that this getter is associated with the setFilename setter which is intended for prefilling the filename when the dialog is open. Although this function does provide the filename of the currently selected file, the intended function to get the selected file when the dialog closes is getSelectedFile().

◆ getFilenameLabelText()

const String& tgui::FileDialog::getFilenameLabelText ( ) const

Return the text of the filename label.

Returns
Current caption of the filename label

◆ getFileTypeFilters()

const std::vector<std::pair<String, std::vector<String> > >& tgui::FileDialog::getFileTypeFilters ( ) const

Returns the file filters which the user can select to only show files of a certain type.

Returns
List of file type filters
See also
setFileTypeFilters

◆ getFileTypeFiltersIndex()

std::size_t tgui::FileDialog::getFileTypeFiltersIndex ( ) const

Returns the index of the currently selected file filter.

Returns
Selected file filter index
See also
setFileTypeFilters

◆ getIconLoader()

std::shared_ptr<FileDialogIconLoader> tgui::FileDialog::getIconLoader ( ) const

Gets the icon loader that is currently being used.

Returns
Current icon loader

◆ getListViewColumnCaptions()

std::tuple<String, String, String> tgui::FileDialog::getListViewColumnCaptions ( ) const

Returns the names of the list view columns.

Returns
Captions displayed in the header of the list view columns
See also
setListViewColumnCaptions

◆ getMultiSelect()

bool tgui::FileDialog::getMultiSelect ( ) const

Returns whether multiple files can be selected.

Returns
Can we select multiple files?

◆ getPath()

const Filesystem::Path& tgui::FileDialog::getPath ( ) const

Returns the directory that is currently being shown in the file dialog.

Returns
Path to displayed directory

◆ getRenderer()

FileDialogRenderer* tgui::FileDialog::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSelectedPaths()

const std::vector<Filesystem::Path>& tgui::FileDialog::getSelectedPaths ( ) const

Returns the selected files/directories.

Returns
File or directory that was selected in the file dialog

Note that this function only returns a value once the open/save button is pressed (or a file is double-clicked). The value is set right before the onFileSelect signal is triggered.

This function returns a path object from which the filename or full path name can be extracted.

dialog->getSelectedPaths()[0].asString() // Returns the entire path as a string (e.g. "/home/user/myfile.txt")
dialog->getSelectedPaths()[0].getFilename() // Returns only the filename component as a string (e.g. "myfile.txt")
dialog->getSelectedPaths()[0].getParentPath().asString() // Returns only the directory as a string (e.g. "/home/user/")

If the file dialog is closed or the cancel button is pressed then the selected paths will be an empty list.

◆ getSelectingDirectory()

bool tgui::FileDialog::getSelectingDirectory ( ) const

Returns whether the file dialog is used for selecting a file or for selecting a directory.

Returns
Is the dialog for selecting a directory instead of for selecting a file?

◆ getSharedRenderer()

FileDialogRenderer* tgui::FileDialog::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal& tgui::FileDialog::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::ChildWindow.

◆ rendererChanged()

void tgui::FileDialog::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::ChildWindow.

◆ setCancelButtonText()

void tgui::FileDialog::setCancelButtonText ( const String text = "Cancel")

Changes the text of the cancel button (e.g. to display it in a different language)

Parameters
textNew text to display on the cancel button

◆ setConfirmButtonText()

void tgui::FileDialog::setConfirmButtonText ( const String text = "Open")

Changes the text of the open/save button.

Parameters
textNew text of the open/save button

◆ setFileMustExist()

void tgui::FileDialog::setFileMustExist ( bool  enforceExistence)

Changes whether the file should exist or whether the filename can be a non-existent file.

Parameters
enforceExistenceShould the open/save button be disabled when the filename doesn't exist?

For an open dialog you probably want this set to true (default) while you usually want it false for a save dialog.

◆ setFilename()

void tgui::FileDialog::setFilename ( const String filename)

Sets the filename that is shown at the bottom of the file dialog.

Parameters
filenameFilename to prefill

◆ setFilenameLabelText()

void tgui::FileDialog::setFilenameLabelText ( const String labelText = "Filename:")

Changes the text of the filename label (e.g. to display it in a different language)

Parameters
labelTextNew text to display on the label

◆ setFileTypeFilters()

void tgui::FileDialog::setFileTypeFilters ( const std::vector< std::pair< String, std::vector< String >>> &  filters,
std::size_t  defaultFilterIndex = 0 
)

Changes the file filters which the user can select to only show files of a certain type.

Parameters
filtersList of file type filters
defaultFilterIndexIndex in the filter list to select by default

Each filter contains of a pair. The first element of the pair is the string that is shown to the user in the combo box. The second element of the pair is a list of expressions that are matched with the filename. If the list of expressions is empty then all files will be shown. If it contains more than 1 string then a file is shown when it matches any of the expressions.

Example usage:

fileDialog->setFileTypeFilters({
{"Single extension", {"*.txt"}},
{"Multiple extension", {"*.png", "*.jpg"}},
{"Specific file", {"config.txt"}},
{"All files", {}}
});
Warning
The wildcard is currently only supported as first character of the string

◆ setIconLoader()

void tgui::FileDialog::setIconLoader ( std::shared_ptr< FileDialogIconLoader iconLoader)

Sets a custom icon loader.

Parameters
iconLoaderNew icon loader to use

The icon loader is responsible loading the application icons that are shown next to files and folders. If no custom icon loader is provided, a default Windows and Linux implementation exists that will use system icons. On other platforms the default icon loader does nothing and no icons are shown next to the files.

◆ setListViewColumnCaptions()

void tgui::FileDialog::setListViewColumnCaptions ( const String nameColumnText = "Name",
const String sizeColumnText = "Size",
const String modifiedColumnText = "Modified" 
)

Changes the names of the list view columns (e.g. to display them in a different language)

Parameters
nameColumnTextCaption to display in the header of the name column
sizeColumnTextCaption to display in the header of the size column
modifiedColumnTextCaption to display in the header of the last modification date column

◆ setMultiSelect()

void tgui::FileDialog::setMultiSelect ( bool  multiSelect)

Changes whether multiple files can be selected.

Parameters
multiSelectCan we select multiple files?

◆ setPath() [1/2]

void tgui::FileDialog::setPath ( const Filesystem::Path path)

Changes the directory for which the files are to be displayed.

Parameters
pathDirectory to show in the file dialog

There is another setPath function that takes a String instead of a Filesystem::Path object as parameter.

◆ setPath() [2/2]

void tgui::FileDialog::setPath ( const String path)

Changes the directory for which the files are to be displayed.

Parameters
pathDirectory to show in the file dialog

There is another setPath function that takes a Filesystem::Path object instead of a String as parameter.

◆ setSelectingDirectory()

void tgui::FileDialog::setSelectingDirectory ( bool  selectDirectories)

Changes whether the file dialog is used for selecting a file or for selecting a directory.

Parameters
selectDirectoriesIs the dialog for selecting a directory instead of for selecting a file?

By default only files can be selected. When changing this setting to true, only folders will be shown and the file type combo box will be hidden.

Member Data Documentation

◆ onFileSelect

SignalPathList tgui::FileDialog::onFileSelect = {"FileSelected"}

The file dialog has been closed. Optional parameter: vector of selected files or empty vector on cancel.

See also
getSelectedPaths

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