VSTGUI 4.10
Graphical User Interface Framework not only for VST plugins
CNewFileSelector Class Referencefinal

New file selector class. More...

#include <cfileselector.h>

+ Inheritance diagram for CNewFileSelector:

Classes

struct  Impl
 

Public Types

enum  Style { kSelectFile , kSelectSaveFile , kSelectDirectory }
 

Public Member Functions

CFileSelector setup
void setTitle (const UTF8String &title)
 set title of file selector More...
 
void setInitialDirectory (const UTF8String &path)
 set initial directory (UTF8 string) More...
 
void setDefaultSaveName (const UTF8String &name)
 set initial save name (UTF8 string) More...
 
void setDefaultExtension (const CFileExtension &extension)
 set default file extension More...
 
void setAllowMultiFileSelection (bool state)
 set allow multi file selection (only valid for kSelectFile selector style) More...
 
void addFileExtension (const CFileExtension &extension)
 add a file extension More...
 
void addFileExtension (CFileExtension &&extension)
 add a file extension More...
 
- Public Member Functions inherited from CBaseObject
 CBaseObject ()=default
 
 ~CBaseObject () noexcept override=default
 
 CBaseObject (const CBaseObject &)
 
CBaseObjectoperator= (const CBaseObject &)
 
virtual CMessageResult notify (CBaseObject *sender, IdStringPtr message)
 
- Public Member Functions inherited from ReferenceCounted< T >
 ReferenceCounted ()=default
 
virtual ~ReferenceCounted () noexcept=default
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0 More...
 
void remember () override
 increase refcount More...
 
virtual int32_t getNbReference () const
 get refcount More...
 
virtual void forget ()=0
 decrease refcount and delete object if refcount == 0 More...
 
virtual void remember ()=0
 increase refcount More...
 

CFileSelector running

using CallbackFunc = std::function< void(CNewFileSelector *)>
 
static CNewFileSelectorcreate (CFrame *parent=nullptr, Style style=kSelectFile)
 create a new instance More...
 
 CNewFileSelector (PlatformFileSelectorPtr &&platformFileSelector, CFrame *parent)
 
bool run (CallbackFunc &&callback)
 
bool run (CBaseObject *delegate)
 the delegate will get a kSelectEndMessage throu the notify method where the sender is this CNewFileSelector object More...
 
void cancel ()
 cancel running the file selector More...
 
bool runModal ()
 run as modal dialog More...
 

CFileSelector result

static IdStringPtr kSelectEndMessage = "CNewFileSelector Select End Message"
 
std::unique_ptr< Implimpl
 
static const CFileExtensiongetAllFilesExtension ()
 get the all files extension More...
 
uint32_t getNumSelectedFiles () const
 get number of selected files More...
 
UTF8StringPtr getSelectedFile (uint32_t index) const
 get selected file. More...
 
CBaseObjectnewCopy () const override
 
 ~CNewFileSelector () noexcept override
 

Detailed Description

New file selector class.

Usage

Running the file selector

void MyClass::runFileSelector ()
{
if (selector)
{
selector->addFileExtension (CFileExtension ("AIFF", "aif", "audio/aiff"));
selector->setDefaultExtension (CFileExtension ("WAVE", "wav"));
selector->setTitle("Choose An Audio File");
selector->run (this);
selector->forget ();
}
}
static CNewFileSelector * create(CFrame *parent=nullptr, Style style=kSelectFile)
create a new instance
Definition: cfileselector.cpp:293
@ kSelectFile
select file(s) selector style
Definition: cfileselector.h:93
CNewFileSelector(PlatformFileSelectorPtr &&platformFileSelector, CFrame *parent)
Definition: cfileselector.cpp:154

Getting results

CMessageResult MyClass::notify (CBaseObject* sender, IdStringPtr message)
{
{
CNewFileSelector* sel = dynamic_cast<CNewFileSelector*>(sender);
if (sel)
{
// do anything with the selected files here
}
}
return parent::notify (sender, message);
}
static IdStringPtr kSelectEndMessage
Definition: cfileselector.h:152
const char * IdStringPtr
ID String pointer.
Definition: vstguibase.h:216
CMessageResult
Definition: vstguibase.h:240
@ kMessageNotified
Definition: vstguibase.h:242

Member Typedef Documentation

◆ CallbackFunc

using CallbackFunc = std::function<void(CNewFileSelector*)>

Member Enumeration Documentation

◆ Style

enum Style
Enumerator
kSelectFile 

select file(s) selector style

kSelectSaveFile 

select save file selector style

kSelectDirectory 

select directory style

Constructor & Destructor Documentation

◆ CNewFileSelector()

CNewFileSelector ( PlatformFileSelectorPtr &&  platformFileSelector,
CFrame parent 
)

◆ ~CNewFileSelector()

~CNewFileSelector ( )
overrideprotecteddefaultnoexcept

Member Function Documentation

◆ addFileExtension() [1/2]

void addFileExtension ( CFileExtension &&  extension)

add a file extension

◆ addFileExtension() [2/2]

void addFileExtension ( const CFileExtension extension)

add a file extension

◆ cancel()

void cancel ( )

cancel running the file selector

◆ create()

CNewFileSelector * create ( CFrame parent = nullptr,
Style  style = kSelectFile 
)
static

create a new instance

◆ getAllFilesExtension()

const CFileExtension & getAllFilesExtension ( )
static

get the all files extension

◆ getNumSelectedFiles()

uint32_t getNumSelectedFiles ( ) const

get number of selected files

◆ getSelectedFile()

UTF8StringPtr getSelectedFile ( uint32_t  index) const

get selected file.

Result is only valid as long as the instance of CNewFileSelector is valid.

◆ newCopy()

CBaseObject * newCopy ( ) const
inlineoverride

◆ run() [1/2]

bool run ( CallbackFunc &&  callback)

◆ run() [2/2]

bool run ( CBaseObject delegate)

the delegate will get a kSelectEndMessage throu the notify method where the sender is this CNewFileSelector object

◆ runModal()

bool runModal ( )

run as modal dialog

◆ setAllowMultiFileSelection()

void setAllowMultiFileSelection ( bool  state)

set allow multi file selection (only valid for kSelectFile selector style)

◆ setDefaultExtension()

void setDefaultExtension ( const CFileExtension extension)

set default file extension

◆ setDefaultSaveName()

void setDefaultSaveName ( const UTF8String name)

set initial save name (UTF8 string)

◆ setInitialDirectory()

void setInitialDirectory ( const UTF8String path)

set initial directory (UTF8 string)

◆ setTitle()

void setTitle ( const UTF8String title)

set title of file selector

Member Data Documentation

◆ impl

std::unique_ptr<Impl> impl
protected

◆ kSelectEndMessage

IdStringPtr kSelectEndMessage = "CNewFileSelector Select End Message"
static

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