TGUI  0.9.1
tgui::FileDialogRenderer Class Reference
Inheritance diagram for tgui::FileDialogRenderer:
tgui::ChildWindowRenderer tgui::WidgetRenderer

Public Member Functions

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

Member Function Documentation

◆ getArrowsOnNavigationButtonsVisible()

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()

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()

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()

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()

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()

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()

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()

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()

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
showArrowsShould 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
rendererDataData 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
rendererDataData 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
rendererDataData 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
rendererDataData 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
rendererDataData 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
rendererDataData 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
rendererDataData 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
rendererDataData 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: