ILocationDialog.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2016.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWGUI_DIALOG_ILOCATIONDIALOG_HPP__
#define __FWGUI_DIALOG_ILOCATIONDIALOG_HPP__

#include <boost/filesystem.hpp>

#include <string>

#include <fwData/location/ILocation.hpp>
#include <fwData/Composite.hpp>

#include "fwGui/GuiBaseObject.hpp"
#include "fwGui/config.hpp"

namespace fwGui
{
namespace dialog
{
class FWGUI_CLASS_API ILocationDialog : public ::fwGui::GuiBaseObject
{

public:

    fwCoreNonInstanciableClassDefinitionsMacro( (ILocationDialog)(::fwGui::GuiBaseObject) )

    typedef enum
    {
        NONE                = 0,
        READ                = 1 << 1,
            WRITE           = 1 << 2,
            FILE_MUST_EXIST = 1 << 3,
    } Options;

    typedef enum
    {
        SINGLE_FILE,
        FOLDER,
        MULTI_FILES
    } Types;

    typedef std::string FactoryRegistryKeyType;

    FWGUI_API static const FactoryRegistryKeyType REGISTRY_KEY;

    FWGUI_API static const std::string SOFTWARE_UI;
    FWGUI_API static const std::string DLG_DEFAULT_LOCATION;

    FWGUI_API virtual ~ILocationDialog();

    FWGUI_API ILocationDialog();

    FWGUI_API virtual void setTitle(const std::string& title);

    FWGUI_API virtual const std::string& getTitle();

    FWGUI_API virtual void setDefaultLocation( ::fwData::location::ILocation::sptr loc);

    FWGUI_API virtual const ::boost::filesystem::path getDefaultLocation();

    FWGUI_API virtual void saveDefaultLocation(::fwData::location::ILocation::sptr loc);

    FWGUI_API virtual void setType( Types type ) = 0;

    FWGUI_API virtual ILocationDialog& setOption( Options option) = 0;

    FWGUI_API virtual void addFilter(const std::string &filterName, const std::string &wildcardList ) = 0;

    FWGUI_API virtual ::fwData::location::ILocation::sptr show() = 0;

    FWGUI_API virtual std::string getCurrentSelection() const = 0;

protected:

    FWGUI_API void readConfig();

    FWGUI_API void writeConfig();

    FWGUI_API ::fwData::Composite::sptr getPreferenceUI();

private:

    std::string m_title;
    ::fwData::location::ILocation::sptr m_defaultLocaction;
};

} //namespace dialog
} // namespace fwGui

#endif /*__FWGUI_DIALOG_ILOCATIONDIALOG_HPP__*/