Urho3D::FileSelector Class Reference

File selector dialog. More...

#include <Urho3D/UI/FileSelector.h>

Inheritance diagram for Urho3D::FileSelector:

Collaboration diagram for Urho3D::FileSelector:

Public Member Functions
	FileSelector (Context *context)
	Construct.
	~FileSelector () override
	Destruct.
void	SetDefaultStyle (XMLFile *style)
void	SetTitle (const String &text)
void	SetButtonTexts (const String &okText, const String &cancelText)
	Set button texts.
void	SetPath (const String &path)
void	SetFileName (const String &fileName)
void	SetFilters (const Vector< 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 String &	GetTitle () const
const String &	GetPath () const
const String &	GetFileName () const
const 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 String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
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	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	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 PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
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, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
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 String &	GetCategory () const
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.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.
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 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.
UIElement *	titleLayout
	Title layout.
Text *	titleText_
	Window title text.
ListView *	fileList_
	File list.
LineEdit *	pathEdit_
	Path editor.
LineEdit *	fileNameEdit_
	Filename editor.
DropDownList *	filterList_
	Filter dropdown.
Button *	okButton_
	OK button.
Text *	okButtonText_
	OK button text.
Button *	cancelButton_
	Cancel button.
Text *	cancelButtonText_
	Cancel button text.
Button *	closeButton_
	Close button.
UIElement *	fileNameLayout_
	Filename and filter layout.
UIElement *	separatorLayout_
	Separator layout.
UIElement *	buttonLayout_
	Button layout.
String	path_
	Current directory.
Vector< String >	filters_
	Filters.
Vector< FileSelectorEntry >	fileEntries_
	File entries.
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
Protected Attributes inherited from Urho3D::Object
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 String & Urho3D::FileSelector::GetFileName

(

)

const

Return current filename.

Here is the call graph for this function:

Here is the caller graph for this function:

GetFileNameEdit()

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

inline

Return filename editor.

GetFilter()

const String & Urho3D::FileSelector::GetFilter

(

)

const

Return current filter.

Here is the call graph for this function:

Here is the caller graph for this function:

GetFilterIndex()

unsigned Urho3D::FileSelector::GetFilterIndex

(

)

const

Return current filter index.

Here is the call graph for this function:

GetFilterList()

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

inline

Return filter dropdown.

GetOKButton()

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

inline

Return OK button.

GetPath()

const String& Urho3D::FileSelector::GetPath ( ) const

inline

Return current path.

GetPathEdit()

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

inline

Return path editor.

GetTitle()

const String & Urho3D::FileSelector::GetTitle

(

)

const

Return window title.

Here is the call graph for this function:

GetTitleText()

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

inline

Return window title text element.

GetWindow()

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

inline

Return fileselector window.

SetDefaultStyle()

void Urho3D::FileSelector::SetDefaultStyle

(

XMLFile *

style

)

Set fileselector UI style.

Here is the call graph for this function:

SetDirectoryMode()

void Urho3D::FileSelector::SetDirectoryMode

(

bool

enable

)

Set directory selection mode. Default false.

SetFileName()

void Urho3D::FileSelector::SetFileName

(

const String &

fileName

)

Set current filename.

Here is the call graph for this function:

Here is the caller graph for this function:

SetPath()

void Urho3D::FileSelector::SetPath

(

const String &

path

)

Set current path.

Here is the call graph for this function:

Here is the caller graph for this function:

SetTitle()

void Urho3D::FileSelector::SetTitle

(

const String &

text

)

Set title text.

Here is the call graph for this function:

---

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

• Source/Urho3D/UI/FileSelector.h
• Source/Urho3D/UI/FileSelector.cpp