VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtFileExtensionManager Class Reference

A singleton manager to provide allowable file extensions for use in file dialogs. More...

Inheritance diagram for makVrv::DtFileExtensionManager:
Inheritance graph
[legend]

Classes

struct  FileExtensionData
 Associate a translatable description with a list of extensions. More...

Public Types

typedef std::list< std::string > ExtensionList
 List of file extensions (gdb, medf, etc.)
typedef std::list
< FileExtensionData
FileExtensionGroup
 List of FileExtensionData records.
typedef boost::unordered_map
< std::string,
FileExtensionGroup
DialogTypeMap
 Map of FileExtensionGroup indexed by DialogType ("AddTerrainPatch", "SaveScene")

Public Member Functions

virtual ~DtFileExtensionManager ()
 DTOR.
virtual void addFileExtensions (const std::string &dialogType, const DtUnicode &description, const ExtensionList &extensions)
 Add a list of extensions (with description) to the specified dialog type's FileExtensionGroup.
virtual void addFileExtension (const std::string &dialogType, const DtUnicode &description, const std::string &extension)
 Add a single extension (with description) to the specified dialog type's FileExtensionGroup.
virtual void removeFileExtensions (const std::string &dialogType, const ExtensionList &extensions)
 Remove a list of extensions.
virtual void removeFileExtension (const std::string &dialogType, const std::string &extension)
 Remove a file extension.
virtual const FileExtensionGroupgetFileExtensions (const std::string &dialogType) const
 Get all the file extension lists associated with the specified dialog type.
virtual bool isMemberOfExtensionGroup (const std::string &dialogType, const DtUnicode &extensionGroup, const std::string &ext)
 Check if a extension is a member of a specific extension group.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtFileExtensionManagerinstance (DtDe &de)
 Lazily create singleton.

Protected Member Functions

 DtFileExtensionManager (DtDe &de)
 CTOR.
virtual bool extensionListsMatch (const ExtensionList &extensions1, const ExtensionList &extensions2)

Protected Attributes

DtDemyDe
DialogTypeMap myFileExtensions

Detailed Description

A singleton manager to provide allowable file extensions for use in file dialogs.

Member Typedef Documentation

typedef std::list<std::string> makVrv::DtFileExtensionManager::ExtensionList

List of file extensions (gdb, medf, etc.)

List of FileExtensionData records.

Each dialog type has one FileExtensionGroip

typedef boost::unordered_map<std::string, FileExtensionGroup> makVrv::DtFileExtensionManager::DialogTypeMap

Map of FileExtensionGroup indexed by DialogType ("AddTerrainPatch", "SaveScene")

Constructor & Destructor Documentation

virtual makVrv::DtFileExtensionManager::~DtFileExtensionManager ( )
virtual

DTOR.

makVrv::DtFileExtensionManager::DtFileExtensionManager ( DtDe de)
protected

CTOR.

Member Function Documentation

static DtFileExtensionManager& makVrv::DtFileExtensionManager::instance ( DtDe de)
static

Lazily create singleton.

virtual void makVrv::DtFileExtensionManager::addFileExtensions ( const std::string &  dialogType,
const DtUnicode description,
const ExtensionList extensions 
)
virtual

Add a list of extensions (with description) to the specified dialog type's FileExtensionGroup.

virtual void makVrv::DtFileExtensionManager::addFileExtension ( const std::string &  dialogType,
const DtUnicode description,
const std::string &  extension 
)
virtual

Add a single extension (with description) to the specified dialog type's FileExtensionGroup.

virtual void makVrv::DtFileExtensionManager::removeFileExtensions ( const std::string &  dialogType,
const ExtensionList extensions 
)
virtual

Remove a list of extensions.

The extension list must be an exact match to an existing extension list in the specified dialog type's FileExtensionGroup

virtual void makVrv::DtFileExtensionManager::removeFileExtension ( const std::string &  dialogType,
const std::string &  extension 
)
virtual

Remove a file extension.

The extension must be the only item in an existing extension list in the specified dialog type's FileExtensionGroup

virtual const FileExtensionGroup& makVrv::DtFileExtensionManager::getFileExtensions ( const std::string &  dialogType) const
virtual

Get all the file extension lists associated with the specified dialog type.

virtual bool makVrv::DtFileExtensionManager::isMemberOfExtensionGroup ( const std::string &  dialogType,
const DtUnicode extensionGroup,
const std::string &  ext 
)
virtual

Check if a extension is a member of a specific extension group.

virtual bool makVrv::DtFileExtensionManager::extensionListsMatch ( const ExtensionList extensions1,
const ExtensionList extensions2 
)
protectedvirtual

Member Data Documentation

DtDe& makVrv::DtFileExtensionManager::myDe
protected
DialogTypeMap makVrv::DtFileExtensionManager::myFileExtensions
protected

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)