tgui::FileDialogRenderer Class Reference

Inheritance diagram for tgui::FileDialogRenderer:

Public Member Functions
void	setListView (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the list view.
TGUI_NODISCARD std::shared_ptr< RendererData >	getListView () const
	Returns the renderer data of the list view.
void	setEditBox (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the path and filename edit boxes.
TGUI_NODISCARD std::shared_ptr< RendererData >	getEditBox () const
	Returns the renderer data of the path and filename edit boxes.
void	setFilenameLabel (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the filename label.
TGUI_NODISCARD std::shared_ptr< RendererData >	getFilenameLabel () const
	Returns the renderer data of the filename label.
void	setFileTypeComboBox (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the file type combo box.
TGUI_NODISCARD std::shared_ptr< RendererData >	getFileTypeComboBox () const
	Returns the renderer data of the file type combo box.
void	setButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the cancel and confirm buttons.
TGUI_NODISCARD std::shared_ptr< RendererData >	getButton () const
	Returns the renderer data of the cancel and confirm buttons.
void	setBackButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the back button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getBackButton () const
	Returns the renderer data of the back button.
void	setForwardButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the forward button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getForwardButton () const
	Returns the renderer data of the forward button.
void	setUpButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the up button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getUpButton () const
	Returns the renderer data of the up button.
void	setArrowsOnNavigationButtonsVisible (bool showArrows)
	Changes whether the arrows are shown on the back, forward and up buttons.
TGUI_NODISCARD bool	getArrowsOnNavigationButtonsVisible () const
	Returns whether the arrows are shown on the back, forward and up buttons.
Public Member Functions inherited from tgui::ChildWindowRenderer
void	setBorders (const Borders &borders)
	Changes the size of the borders.
TGUI_NODISCARD Borders	getBorders () const
	Returns the size of the borders.
void	setTitleBarHeight (float height)
	Changes the height of the title bar.
TGUI_NODISCARD float	getTitleBarHeight () const
	Returns the height of the title bar.
void	setTitleBarColor (Color color)
	Changes the color of the title bar.
TGUI_NODISCARD Color	getTitleBarColor () const
	Returns the color of the title bar.
void	setTitleColor (Color color)
	Changes the color of the title that is displayed in the title bar of the child window.
TGUI_NODISCARD Color	getTitleColor () const
	Returns the color of the title that is displayed in the title bar of the child window.
void	setBackgroundColor (Color color)
	Changes the color of the background.
TGUI_NODISCARD Color	getBackgroundColor () const
	Returns the color of the background.
void	setBorderColor (Color color)
	Changes the color of the borders.
TGUI_NODISCARD Color	getBorderColor () const
	Returns the color of the borders.
void	setBorderColorFocused (Color color)
	Changes the color of the borders when the widget is focused.
TGUI_NODISCARD Color	getBorderColorFocused () const
	Returns the color of the borders when the widget is focused.
void	setBorderBelowTitleBar (float border)
	Changes the distance between the title bar and the actual contents of the child window.
TGUI_NODISCARD float	getBorderBelowTitleBar () const
	Returns the distance between the title bar and the actual contents of the child window.
void	setDistanceToSide (float distanceToSide)
	Changes the distance of the title or close button from the side of the title bar.
TGUI_NODISCARD float	getDistanceToSide () const
	Returns the distance of the title or close button from the side of the title bar.
void	setPaddingBetweenButtons (float padding)
	Changes the distance between the title buttons if multiple exist.
TGUI_NODISCARD float	getPaddingBetweenButtons () const
	Returns the distance between the title buttons if multiple exist.
void	setMinimumResizableBorderWidth (float minimumBorderWidth)
	Changes the minimum width of the area where you can drag to resize the child window.
TGUI_NODISCARD float	getMinimumResizableBorderWidth () const
	Returns the minimum width of the area where you can drag to resize the child window.
void	setShowTextOnTitleButtons (bool showText)
	Changes whether characters are rendered on top of the title buttons.
TGUI_NODISCARD bool	getShowTextOnTitleButtons () const
	Returns whether characters are rendered on top of the title buttons.
void	setTextureTitleBar (const Texture &texture)
	Changes the image of the title bar.
TGUI_NODISCARD const Texture &	getTextureTitleBar () const
	Returns the image of the title bar.
void	setTextureBackground (const Texture &texture)
	Changes the background image.
TGUI_NODISCARD const Texture &	getTextureBackground () const
	Returns the background image.
void	setCloseButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional close button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getCloseButton () const
	Returns the renderer data of the close button.
void	setMaximizeButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional maximize button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getMaximizeButton () const
	Returns the renderer data of the maximize button.
void	setMinimizeButton (std::shared_ptr< RendererData > rendererData)
	Sets the renderer data of the optional minimize button.
TGUI_NODISCARD std::shared_ptr< RendererData >	getMinimizeButton () const
	Returns the renderer data of the minimize button.
	WidgetRenderer ()=default
	Default constructor.
	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.
	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.
	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.
Public Member Functions inherited from tgui::WidgetRenderer
	WidgetRenderer ()=default
	Default constructor.
	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.
	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.
WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.
WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.
	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.
virtual	~WidgetRenderer ()=default
	Virtual destructor.
void	setOpacity (float opacity)
	Changes the opacity of the widget.
TGUI_NODISCARD float	getOpacity () const
	Returns the opacity of the widget.
void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.
TGUI_NODISCARD float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled.
void	setFont (const Font &font)
	Changes the font used for the text in the widget.
TGUI_NODISCARD Font	getFont () const
	Returns the font associated with the widget (if any)
void	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.
TGUI_NODISCARD unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.
void	setTransparentTexture (bool ignoreTransparentParts)
	Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.
TGUI_NODISCARD bool	getTransparentTexture () const
	Returns whether mouse events should be ignored on transparent parts of the texture of the widget.
void	setProperty (const String &property, ObjectConverter &&value)
	Changes a property of the renderer.
TGUI_NODISCARD ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.
TGUI_NODISCARD const std::map< String, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values.
void	subscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.
void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.
void	setData (const std::shared_ptr< RendererData > &data)
TGUI_NODISCARD std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.
TGUI_NODISCARD std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

getArrowsOnNavigationButtonsVisible()

TGUI_NODISCARD bool tgui::FileDialogRenderer::getArrowsOnNavigationButtonsVisible

(

)

const

Returns whether the arrows are shown on the back, forward and up buttons.

Returns

Is an arrow character displayed on top of the navigation buttons?

See also

setArrowsOnNavigationButtonsVisible

getBackButton()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getBackButton

(

)

const

Returns the renderer data of the back button.

Returns

Data about how the back button looks

When this returns a nullptr (default), then the Button property is used as renderer data for the back button.

getButton()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getButton

(

)

const

Returns the renderer data of the cancel and confirm buttons.

Returns

Data about how the buttons look

When BackButton, ForwardButton or UpButton are set to nullptr (default), then this property is also used for them

getEditBox()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getEditBox

(

)

const

Returns the renderer data of the path and filename edit boxes.

Returns

Data about how the edit boxes looks

getFilenameLabel()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getFilenameLabel

(

)

const

Returns the renderer data of the filename label.

Returns

Data about how the filename label looks

getFileTypeComboBox()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getFileTypeComboBox

(

)

const

Returns the renderer data of the file type combo box.

Returns

Data about how the file type combo box looks

getForwardButton()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getForwardButton

(

)

const

Returns the renderer data of the forward button.

Returns

Data about how the forward button looks

When this returns a nullptr (default), then the Button property is used as renderer data for the forward button.

getListView()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getListView

(

)

const

Returns the renderer data of the list view.

Returns

Data about how the list view looks

getUpButton()

TGUI_NODISCARD std::shared_ptr< RendererData > tgui::FileDialogRenderer::getUpButton

(

)

const

Returns the renderer data of the up button.

Returns

Data about how the up button looks

When this returns a nullptr (default), then the Button property is used as renderer data for the up button.

setArrowsOnNavigationButtonsVisible()

void tgui::FileDialogRenderer::setArrowsOnNavigationButtonsVisible

(

bool

showArrows

)

Changes whether the arrows are shown on the back, forward and up buttons.

Parameters

showArrows

Should an arrow character be displayed on top of the navigation buttons?

The arrows are shown by default. You may want to hide them if you use textures for those buttons which include an icon. The arrows are meant to be used only when the buttons have a generic theme without an icon on them.

setBackButton()

void tgui::FileDialogRenderer::setBackButton

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the back button.

Parameters

rendererData

Data about how the back button should look

When set to a nullptr (default), the Button property will be used as renderer data for the back button.

setButton()

void tgui::FileDialogRenderer::setButton

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the cancel and confirm buttons.

Parameters

rendererData

Data about how the buttons should look

When BackButton, ForwardButton or UpButton are set to nullptr (default), then this property is also used for them

setEditBox()

void tgui::FileDialogRenderer::setEditBox

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the path and filename edit boxes.

Parameters

rendererData

Data about how the edit boxes should look

setFilenameLabel()

void tgui::FileDialogRenderer::setFilenameLabel

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the filename label.

Parameters

rendererData

Data about how the filename label should look

setFileTypeComboBox()

void tgui::FileDialogRenderer::setFileTypeComboBox

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the file type combo box.

Parameters

rendererData

Data about how the file type combo box should look

setForwardButton()

void tgui::FileDialogRenderer::setForwardButton

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the forward button.

Parameters

rendererData

Data about how the forward button should look

When set to a nullptr (default), the Button property will be used as renderer data for the forward button.

setListView()

void tgui::FileDialogRenderer::setListView

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the list view.

Parameters

rendererData

Data about how the list view should look

setUpButton()

void tgui::FileDialogRenderer::setUpButton

(

std::shared_ptr< RendererData >

rendererData

)

Sets the renderer data of the up button.

Parameters

rendererData

Data about how the up button should look

When set to a nullptr (default), the Button property will be used as renderer data for the up button.

---

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

• include/TGUI/Renderers/FileDialogRenderer.hpp