File selector dialog. More...

#include <Urho3D/UI/FileSelector.h>

Inheritance diagram for Urho3D::FileSelector:

Public Member Functions
	FileSelector (Context *context)
	Construct.

	~FileSelector () override
	Destruct.

void	SetDefaultStyle (XMLFile *style)

void	SetTitle (const ea::string &text)

void	SetButtonTexts (const ea::string &okText, const ea::string &cancelText)
	Set button texts.

void	SetPath (const ea::string &path)

void	SetFileName (const ea::string &fileName)

void	SetFilters (const ea::vector< ea::string > &filters, unsigned defaultIndex)
	Set filters.

void	SetDirectoryMode (bool enable)

void	UpdateElements ()
	Update elements to layout properly. Call this after manually adjusting the sub-elements.

XMLFile *	GetDefaultStyle () const

Window *	GetWindow () const

Text *	GetTitleText () const

ListView *	GetFileList () const

LineEdit *	GetPathEdit () const

LineEdit *	GetFileNameEdit () const

DropDownList *	GetFilterList () const

Button *	GetOKButton () const

Button *	GetCancelButton () const

Button *	GetCloseButton () const
	Return close button.

const ea::string &	GetTitle () const

const ea::string &	GetPath () const

const ea::string &	GetFileName () const

const ea::string &	GetFilter () const

unsigned	GetFilterIndex () const

bool	GetDirectoryMode () const

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (FileSelector, Object)

void	SetLineEditText (LineEdit *edit, const ea::string &text)
	Set the text of an edit field and ignore the resulting event.

void	RefreshFiles ()
	Refresh the directory listing.

bool	EnterFile ()
	Enter a directory or confirm a file. Return true if a directory entered.

void	HandleFilterChanged (StringHash eventType, VariantMap &eventData)
	Handle filter changed.

void	HandlePathChanged (StringHash eventType, VariantMap &eventData)
	Handle path edited.

void	HandleFileSelected (StringHash eventType, VariantMap &eventData)
	Handle file selected from the list.

void	HandleFileDoubleClicked (StringHash eventType, VariantMap &eventData)
	Handle file doubleclicked from the list (enter directory / OK the file selection).

void	HandleFileListKey (StringHash eventType, VariantMap &eventData)
	Handle file list key pressed.

void	HandleOKPressed (StringHash eventType, VariantMap &eventData)
	Handle OK button pressed.

void	HandleCancelPressed (StringHash eventType, VariantMap &eventData)
	Handle cancel button pressed.

Private Attributes
SharedPtr< Window >	window_
	Fileselector window.

SharedPtr< UIElement >	titleLayout
	Title layout.

SharedPtr< Text >	titleText_
	Window title text.

SharedPtr< ListView >	fileList_
	File list.

SharedPtr< LineEdit >	pathEdit_
	Path editor.

SharedPtr< LineEdit >	fileNameEdit_
	Filename editor.

SharedPtr< DropDownList >	filterList_
	Filter dropdown.

SharedPtr< Button >	okButton_
	OK button.

SharedPtr< Text >	okButtonText_
	OK button text.

SharedPtr< Button >	cancelButton_
	Cancel button.

SharedPtr< Text >	cancelButtonText_
	Cancel button text.

SharedPtr< Button >	closeButton_
	Close button.

SharedPtr< UIElement >	fileNameLayout_
	Filename and filter layout.

SharedPtr< UIElement >	separatorLayout_
	Separator layout.

SharedPtr< UIElement >	buttonLayout_
	Button layout.

ea::string	path_
	Current directory.

ea::vector< ea::string >	filters_
	Filters.

ea::vector< FileSelectorEntry >	fileEntries_
	File entries.

ea::string	lastUsedFilter_
	Filter used to get the file list.

bool	directoryMode_
	Directory mode flag.

bool	ignoreEvents_
	Ignore events flag, used when changing line edits manually.

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

File selector dialog.

Member Function Documentation

◆ GetCancelButton()

Button* Urho3D::FileSelector::GetCancelButton ( ) const

inline

Return cancel button.

◆ GetDefaultStyle()

XMLFile * Urho3D::FileSelector::GetDefaultStyle ( ) const

Return the UI style file.

◆ GetDirectoryMode()

bool Urho3D::FileSelector::GetDirectoryMode ( ) const

inline

Return directory mode flag.

◆ GetFileList()

ListView* Urho3D::FileSelector::GetFileList ( ) const

inline

Return file list.

◆ GetFileName()

const ea::string & Urho3D::FileSelector::GetFileName ( ) const

Return current filename.

◆ GetFileNameEdit()

LineEdit* Urho3D::FileSelector::GetFileNameEdit ( ) const

inline

Return filename editor.

◆ GetFilter()

const ea::string & Urho3D::FileSelector::GetFilter ( ) const

Return current filter.

◆ GetFilterIndex()

unsigned Urho3D::FileSelector::GetFilterIndex ( ) const

Return current filter index.

◆ GetFilterList()

DropDownList* Urho3D::FileSelector::GetFilterList ( ) const

inline

Return filter dropdown.

◆ GetOKButton()

Button* Urho3D::FileSelector::GetOKButton ( ) const

inline

Return OK button.

◆ GetPath()

const ea::string& Urho3D::FileSelector::GetPath ( ) const

inline

Return current path.

◆ GetPathEdit()

LineEdit* Urho3D::FileSelector::GetPathEdit ( ) const

inline

Return path editor.

◆ GetTitle()

const ea::string & Urho3D::FileSelector::GetTitle ( ) const

Return window title.

◆ GetTitleText()

Text* Urho3D::FileSelector::GetTitleText ( ) const

inline

Return window title text element.

◆ GetWindow()

Window* Urho3D::FileSelector::GetWindow ( ) const

inline

Return fileselector window.

◆ RegisterObject()

void Urho3D::FileSelector::RegisterObject ( Context * context )

static

Register object factory.

◆ SetDefaultStyle()

void Urho3D::FileSelector::SetDefaultStyle ( XMLFile * style )

Set fileselector UI style.

◆ SetDirectoryMode()

void Urho3D::FileSelector::SetDirectoryMode ( bool enable )

Set directory selection mode. Default false.

◆ SetFileName()

void Urho3D::FileSelector::SetFileName ( const ea::string & fileName )

Set current filename.

◆ SetPath()

void Urho3D::FileSelector::SetPath ( const ea::string & path )

Set current path.

◆ SetTitle()

void Urho3D::FileSelector::SetTitle ( const ea::string & text )

Set title text.

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

Urho3D/UI/FileSelector.h
Urho3D/UI/FileSelector.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetCancelButton()

◆ GetDefaultStyle()

◆ GetDirectoryMode()

◆ GetFileList()

◆ GetFileName()

◆ GetFileNameEdit()

◆ GetFilter()

◆ GetFilterIndex()

◆ GetFilterList()

◆ GetOKButton()

◆ GetPath()

◆ GetPathEdit()

◆ GetTitle()

◆ GetTitleText()

◆ GetWindow()

◆ RegisterObject()

◆ SetDefaultStyle()

◆ SetDirectoryMode()

◆ SetFileName()

◆ SetPath()

◆ SetTitle()