File selector dialog. More...

#include <Urho3D/UI/FileSelector.h>

Inheritance diagram for Urho3D::FileSelector:
[legend]
Collaboration diagram for Urho3D::FileSelector:
[legend]

Public Member Functions

 FileSelector (Context *context)
 Construct.
 
virtual ~FileSelector () override
 Destruct.
 
void SetDefaultStyle (XMLFile *style)
 Set fileselector UI style.
 
void SetTitle (const String &text)
 Set title text.
 
void SetButtonTexts (const String &okText, const String &cancelText)
 Set button texts.
 
void SetPath (const String &path)
 Set current path.
 
void SetFileName (const String &fileName)
 Set current filename.
 
void SetFilters (const Vector< String > &filters, unsigned defaultIndex)
 Set filters.
 
void SetDirectoryMode (bool enable)
 Set directory selection mode. Default false.
 
void UpdateElements ()
 Update elements to layout properly. Call this after manually adjusting the sub-elements.
 
XMLFileGetDefaultStyle () const
 Return the UI style file.
 
WindowGetWindow () const
 Return fileselector window.
 
TextGetTitleText () const
 Return window title text element.
 
ListViewGetFileList () const
 Return file list.
 
LineEditGetPathEdit () const
 Return path editor.
 
LineEditGetFileNameEdit () const
 Return filename editor.
 
DropDownListGetFilterList () const
 Return filter dropdown.
 
ButtonGetOKButton () const
 Return OK button.
 
ButtonGetCancelButton () const
 Return cancel button.
 
ButtonGetCloseButton () const
 Return close button.
 
const StringGetTitle () const
 Return window title.
 
const StringGetPath () const
 Return current path.
 
const StringGetFileName () const
 Return current filename.
 
const StringGetFilter () const
 Return current filter.
 
unsigned GetFilterIndex () const
 Return current filter index.
 
bool GetDirectoryMode () const
 Return directory mode flag.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () 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.
 
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.
 
VariantMapGetEventDataMap () 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.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
- 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.
 
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
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 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 TypeInfoGetTypeInfoStatic ()
 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< Windowwindow_
 Fileselector window.
 
UIElementtitleLayout
 Title layout.
 
TexttitleText_
 Window title text.
 
ListViewfileList_
 File list.
 
LineEditpathEdit_
 Path editor.
 
LineEditfileNameEdit_
 Filename editor.
 
DropDownListfilterList_
 Filter dropdown.
 
ButtonokButton_
 OK button.
 
TextokButtonText_
 OK button text.
 
ButtoncancelButton_
 Cancel button.
 
TextcancelButtonText_
 Cancel button text.
 
ButtoncloseButton_
 Close button.
 
UIElementfileNameLayout_
 Filename and filter layout.
 
UIElementseparatorLayout_
 Separator layout.
 
UIElementbuttonLayout_
 Button layout.
 
String path_
 Current directory.
 
Vector< Stringfilters_
 Filters.
 
Vector< FileSelectorEntryfileEntries_
 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
Contextcontext_
 Execution context.
 

Detailed Description

File selector dialog.


The documentation for this class was generated from the following files:
  • Source/Urho3D/UI/FileSelector.h
  • Source/Urho3D/UI/FileSelector.cpp