CCommandBasedSelectionControllerComp.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#ifndef iqtgui_CCommandBasedSelectionControllerComp_included
#define iqtgui_CCommandBasedSelectionControllerComp_included
 
 
// ICF includes
#include <imod/TSingleModelObserverBase.h>
#include <icomp/CComponentBase.h>
#include <ibase/ICommandsProvider.h>
#include <ibase/TVisualChangesHandlerWrap.h>
#include <iprm/ISelectionParam.h>
#include <istdgui/IIconProvider.h>
#include <istdgui/CHierarchicalCommand.h>
 
 
namespace istdgui
{
 
 
class CCommandBasedSelectionControllerComp:
            public QObject,
            public ibase::TVisualChangesHandlerWrap<icomp::CComponentBase>,
            protected imod::TSingleModelObserverBase<iprm::ISelectionParam>,
            virtual public ibase::ICommandsProvider
{
    Q_OBJECT
public:
    typedef ibase::TVisualChangesHandlerWrap<icomp::CComponentBase> BaseClass;
    typedef imod::TSingleModelObserverBase<iprm::ISelectionParam> BaseClass2;
    
    I_BEGIN_COMPONENT(CCommandBasedSelectionControllerComp);
        I_REGISTER_INTERFACE(ibase::ICommandsProvider);
        I_ASSIGN(m_commandSelectionCompPtr, "CommandsSelection", "Commands selector and contstraints provider", true, "CommandsSelection");
        I_ASSIGN_TO(m_commandSelectionModelCompPtr, m_commandSelectionCompPtr, true);
        I_ASSIGN(m_actionIconsProviderCompPtr, "ActionIcons", "Icons for the region actions", false, "ActionIcons");
        I_ASSIGN(m_noSelectionCommandAttrPtr, "UnselectActionName", "The name of the unselect action", false, "Deselect");
        I_ASSIGN(m_menuNameAttrPtr, "MenuName", "Name of the menu for the action group", true, "Selection");
        I_ASSIGN(m_menuDescriptionAttrPtr, "MenuDescription", "Description for the action group", true, "");
        I_ASSIGN(m_rootMenuNameAttrPtr, "RootMenu", "Name of the root command", true, "");
        I_ASSIGN(m_showInToolBarAttrPtr, "ShowInToolBar", "If enabled, the action will be shown in the application's tool bar", false, false);
        I_ASSIGN(m_commandPriorityAttrPtr, "CommandPriority", "Defines the used command priority for the menu", true, 100);
    I_END_COMPONENT;
 
    CCommandBasedSelectionControllerComp();
 
    // reimpemented (ibase::ICommandsProvider)
    const ibase::IHierarchicalCommand* GetCommands() const override;
 
protected:
    // reimplemented (ibase::TVisualChangesHandlerWrap)
    void OnLanguageChanged() override;
 
    // reimpemented (imod::CSingleModelObserverBase)
    void OnUpdate(const istd::IChangeable::ChangeSet& changeSet) override;
 
    // reimpemented (icomp::IComponent)
    void OnComponentCreated() override;
    void OnComponentDestroyed() override;
 
private Q_SLOTS:
    void OnCommandActivated();
 
private:
    void BuildCommands();
 
protected:
    I_REF(iprm::ISelectionParam, m_commandSelectionCompPtr);
    I_REF(imod::IModel, m_commandSelectionModelCompPtr);
    I_REF(istdgui::IIconProvider, m_actionIconsProviderCompPtr);
    I_TEXTATTR(m_noSelectionCommandAttrPtr);
    I_TEXTATTR(m_menuNameAttrPtr);
    I_TEXTATTR(m_menuDescriptionAttrPtr);
    I_TEXTATTR(m_rootMenuNameAttrPtr);
    I_ATTR(bool, m_showInToolBarAttrPtr);
    I_ATTR(int, m_commandPriorityAttrPtr);
 
    istdgui::CHierarchicalCommand m_rootMenuCommand;
    istdgui::CHierarchicalCommand m_mainMenuCommand;
    istdgui::CHierarchicalCommand m_commandsList;
};
 
 
} // namespace istdgui
 
 
#endif // !iqtgui_CCommandBasedSelectionControllerComp_included