fw4spl
fwGuiQt::dialog::LocationDialog Class Reference

Defines the generic file/folder dialog for IHM. More...

#include <LocationDialog.hpp>

+ Inheritance diagram for fwGuiQt::dialog::LocationDialog:
+ Collaboration diagram for fwGuiQt::dialog::LocationDialog:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWGUIQT_API LocationDialog (::fwGui::GuiBaseObject::Key key)
 
FWGUIQT_API::fwData::location::ILocation::sptr show () override
 
FWGUIQT_API void setType (::fwGui::dialog::ILocationDialog::Types type) override
 
FWGUIQT_API::fwGui::dialog::ILocationDialog & setOption (::fwGui::dialog::ILocationDialog::Options option) override
 
FWGUIQT_API void addFilter (const std::string &filterName, const std::string &wildcardList) override
 specify some filtering when browsing files: More...
 
- Public Member Functions inherited from fwGui::dialog::ILocationDialog
virtual FWGUI_API void setTitle (const std::string &title)
 set the title for the dialog
 
virtual FWGUI_API const std::string & getTitle ()
 returns the title for the dialog
 
virtual FWGUI_API void setDefaultLocation (::fwData::location::ILocation::sptr loc)
 set the initial location for the dialog
 
virtual FWGUI_APIconst::boost::filesystem::path getDefaultLocation ()
 get the default location for the dialog (from preferences or specified by user)
 
virtual FWGUI_API void saveDefaultLocation (::fwData::location::ILocation::sptr loc)
 save the specified default location for the dialog in preferences (if available)
 
virtual FWGUI_API void setType (Types type)=0
 set the type of location for the dialog (SINGLE_FILE, FORLDER, MULTI_FILES)
 
virtual FWGUI_API ILocationDialogsetOption (Options option)=0
 allow to set option to the file dialog mode=READ/WRITE , check=FILE_MUST_EXIST
 
- Public Member Functions inherited from fwGui::GuiBaseObject
- Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwGui::dialog::ILocationDialog
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwGui::GuiBaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- Static Public Member Functions inherited from fwCore::BaseObject
static bool isTypeOf (const std::string &type)
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Protected Member Functions

QString fileFilters ()
 helper to transform m_filters into qt encoding ("BMP and GIF files (*.bmp *.gif);;PNG files (*.png)"
 
FWGUIQT_API std::string getCurrentSelection () const override
 Gets the current extension file selection.
 
- Protected Member Functions inherited from fwGui::dialog::ILocationDialog
FWGUI_API void readConfig ()
 
FWGUI_API void writeConfig ()
 
FWGUI_API::fwData::Composite::sptr getPreferenceUI ()
 
- Protected Member Functions inherited from fwGui::GuiBaseObject
 GuiBaseObject ()
 
virtual ~GuiBaseObject ()
 

Protected Attributes

::fwGui::dialog::ILocationDialog::Options m_style
 
::fwGui::dialog::ILocationDialog::Types m_type
 
std::vector< std::pair< std::string, std::string > > m_filters
 
std::string m_wildcard
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

Demangling methods

virtual const std::string & getLeafClassname () const override
 return object's classname without its namespace, i.e. BaseObject
 
virtual const std::string & getClassname () const override
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
static const std::string & leafClassname ()
 return object's classname without its namespace, i.e. BaseObject
 
static const std::string & classname ()
 return object's classname without its namespace, i.e. BaseObject
 

Additional Inherited Members

- Public Types inherited from fwGui::dialog::ILocationDialog
enum  Options { NONE = 0, READ = 1 << 1, WRITE = 1 << 2, FILE_MUST_EXIST = 1 << 3 }
 
enum  Types { SINGLE_FILE, FOLDER, MULTI_FILES }
 
typedef std::string FactoryRegistryKeyType
 
- Public Types inherited from fwGui::GuiBaseObject
typedef ::fwGui::factory::Key Key
 
- Static Public Attributes inherited from fwGui::dialog::ILocationDialog
static FWGUI_API const FactoryRegistryKeyType REGISTRY_KEY = "::fwGui::dialog::LocationDialog"
 this unique key should be used for all factory for specific LocationDialog(qt,wx,...)
 
static FWGUI_API const std::string SOFTWARE_UI = "SOFTWARE_UI"
 
static FWGUI_API const std::string DLG_DEFAULT_LOCATION = "DLG_DEFAULT_LOCATION"
 

Detailed Description

Defines the generic file/folder dialog for IHM.

Definition at line 29 of file t/include/fwGuiQt/dialog/LocationDialog.hpp.

Member Function Documentation

void fwGuiQt::dialog::LocationDialog::addFilter ( const std::string &  filterName,
const std::string &  wildcardList 
)
overridevirtual

specify some filtering when browsing files:

Parameters
[in]filterNamea string that will be displayed as filter name
[in]wildcardLista string of extension (glob syntax) separated by spaces example : addFilter("images","*.png *.jpg")

Implements fwGui::dialog::ILocationDialog.

Definition at line 176 of file t/src/fwGuiQt/dialog/LocationDialog.cpp.

fwData::location::ILocation::sptr fwGuiQt::dialog::LocationDialog::show ( )
overridevirtual

Display the dialog

Returns
the ILocation selected or null sptr if user cancel the operation

Implements fwGui::dialog::ILocationDialog.

Definition at line 43 of file t/src/fwGuiQt/dialog/LocationDialog.cpp.

References fwGui::dialog::LocationDialog::getDefaultLocation(), fwGui::dialog::LocationDialog::getTitle(), fwGui::dialog::LocationDialog::setOption(), fwGui::dialog::LocationDialog::setType(), and SLM_ASSERT.

+ Here is the call graph for this function:


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