IFrameLayoutManager.hpp

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

#pragma once

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

#include <fwData/Composite.hpp>

#include <fwRuntime/ConfigurationElement.hpp>

#include <boost/filesystem/path.hpp>

#include <functional>
#include <list>

namespace fwGui
{
namespace layoutManager
{

class FWGUI_CLASS_API IFrameLayoutManager : public ::fwGui::GuiBaseObject
{

public:

    fwCoreNonInstanciableClassDefinitionsMacro( (IFrameLayoutManager)(::fwGui::GuiBaseObject) )

    typedef ::fwRuntime::ConfigurationElement::sptr ConfigurationType;

    typedef enum
    {
        DEFAULT,
        STAY_ON_TOP,
        MODAL
    } Style;

    typedef std::string RegistryKeyType;

    static const std::string SOFTWARE_UI;
    static const std::string FRAME_STATE_UI;
    static const std::string FRAME_SIZE_W_UI;
    static const std::string FRAME_SIZE_H_UI;
    static const std::string FRAME_POSITION_X_UI;
    static const std::string FRAME_POSITION_Y_UI;

    typedef enum
    {
        UNKNOWN,     
        ICONIZED,    
        MAXIMIZED,   
        FULL_SCREEN  
    } FrameState;

    class FrameInfo
    {
    public:

        FrameInfo() :
            m_name(""),
            m_minSize(std::make_pair(-1, -1)),
            m_style(DEFAULT),
            m_size(std::make_pair(-1, -1)),
            m_position(std::make_pair(-1, -1)),
            m_state(UNKNOWN)
        {
        }

        std::string m_name;
        ::boost::filesystem::path m_iconPath;
        std::pair< int, int >            m_minSize;
        Style m_style;
        std::pair< int, int >            m_size;
        std::pair< int, int >            m_position;
        FrameState m_state;
    };

    FWGUI_API IFrameLayoutManager();

    FWGUI_API virtual ~IFrameLayoutManager();

    FWGUI_API virtual void initialize( ConfigurationType configuration);

    FWGUI_API static const RegistryKeyType REGISTRY_KEY;

    FWGUI_API virtual void createFrame() = 0;

    FWGUI_API virtual void destroyFrame() = 0;

    virtual ::fwGui::container::fwContainer::sptr getFrame()
    {
        return m_frame;
    }

    virtual ::fwGui::container::fwContainer::sptr getContainer()
    {
        return m_container;
    }

    typedef std::function< void () > CloseCallback;
    FWGUI_API virtual void setCloseCallback(CloseCallback fct);

protected:

    const FrameInfo& getFrameInfo() const
    {
        return m_frameInfo;
    }

    //------------------------------------------------------------------------------

    FrameInfo& getFrameInfo()
    {
        return m_frameInfo;
    }

    //------------------------------------------------------------------------------

    void setFrameInfo(const FrameInfo& frameInfo)
    {
        m_frameInfo = frameInfo;
    }
    ::fwGui::container::fwContainer::sptr m_frame;
    ::fwGui::container::fwContainer::sptr m_container;
    CloseCallback m_closeCallback;

    FWGUI_API void readConfig();

    FWGUI_API void writeConfig();

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

private:

    void defaultCloseCallback();

    FrameInfo m_frameInfo;

};

} // namespace layoutManager
} // namespace fwGui