command.h

/******************************************************************************
 * Project:  wxGIS (GIS Catalog)
 * Purpose:  wxGISCommonCmd class.
 * Author:   Dmitry Baryshnikov (aka Bishop), polimax@mail.ru
 ******************************************************************************
*   Copyright (C) 2009,2012 Dmitry Baryshnikov
*
*    This program is free software: you can redistribute it and/or modify
*    it under the terms of the GNU General Public License as published by
*    the Free Software Foundation, either version 2 of the License, or
*    (at your option) any later version.
*
*    This program is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*    GNU General Public License for more details.
*
*    You should have received a copy of the GNU General Public License
*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************/
#pragma once

#include "wxgis/framework/framework.h"

#define NO_CATEGORY wxString(_("[No category]"))

class WXDLLIMPEXP_GIS_FRW wxGISApplicationBase;
enum wxGISEnumCommandKind
{
    enumGISCommandSeparator = wxITEM_SEPARATOR, 
    enumGISCommandNormal = wxITEM_NORMAL,       
    enumGISCommandCheck = wxITEM_CHECK,         
    enumGISCommandRadio = wxITEM_RADIO,         
    enumGISCommandMax = wxITEM_MAX,             
    enumGISCommandMenu = wxITEM_MAX + 10,       
    enumGISCommandControl,                      
    enumGISCommandDropDown                      
};

class WXDLLIMPEXP_GIS_FRW wxGISCommand : public wxObject
{
    //DECLARE_ABSTRACT_CLASS(wxGISCommand)
public:
    wxGISCommand(void);
    virtual ~wxGISCommand(void);
    //pure virtual
    virtual wxIcon GetBitmap(void) = 0;
    virtual wxString GetCaption(void) = 0;
    virtual wxString GetCategory(void) = 0;
    virtual bool GetChecked(void) = 0;
    virtual bool GetEnabled(void) = 0;
    virtual wxString GetMessage(void) = 0;
    virtual wxGISEnumCommandKind GetKind(void) = 0;
    virtual void OnClick(void) = 0;
    virtual bool OnCreate(wxGISApplicationBase* pApp) = 0;
    virtual wxString GetTooltip(void) = 0;
    virtual unsigned char GetCount(void) = 0;
    virtual void SetId(long nId);
    virtual long GetId(void) const;
    //
    virtual void SetSubType(unsigned char SubType);
    virtual unsigned char GetSubType(void) const;
protected:
    unsigned char m_subtype;
    long m_CommandId;
};

WX_DEFINE_ARRAY_PTR(wxGISCommand*, wxCommandPtrArray);

class IToolBarControl
{
public:
    virtual ~IToolBarControl(void) {};
    virtual void Activate(wxGISApplicationBase* pApp) = 0;
    virtual void Deactivate(void) = 0;
};

class IToolControl
{
public:
    virtual ~IToolControl(void) {};
    virtual IToolBarControl* GetControl(void) = 0;
    virtual wxString GetToolLabel(void) = 0;
    virtual bool HasToolLabel(void) = 0;
};

class ITool :
    public wxGISCommand
{
public:
    virtual ~ITool(void) {};
    virtual void SetChecked(bool bCheck) = 0;
    virtual wxCursor GetCursor(void) = 0;
    virtual void OnMouseDown(wxMouseEvent& event) = 0;
    virtual void OnMouseUp(wxMouseEvent& event) = 0;
    virtual void OnMouseMove(wxMouseEvent& event) = 0;
    virtual void OnMouseDoubleClick(wxMouseEvent& event) = 0;
};

class IDropDownCommand
{
public:
    virtual ~IDropDownCommand(void) {};
    virtual wxMenu* GetDropDownMenu(void) = 0;
    virtual void OnDropDownCommand(int nID) = 0;
};

enum wxGISEnumCommonCmdType{
    enumGISCommonCmdExit = 0,   //  0   Exit
    enumGISCommonCmdAbout,      //  1   About
    enumGISCommonCmdCustomize,  //  2   Customize
    enumGISCommonCmdSeparator,  //  3   Separator
    enumGISCommonCmdStatusBar,  //  4   StatusBar
    enumGISCommonCmdOptions,    //  5   Options
    enumGISCommonCmdFitToolbars,//  6   FitToolbars
    enumGISCommonCmdOptimizeToolbars,    //  7   OptimizeToolbars
    enumGISCommonCmdMax
};

class wxGISCommonCmd :
    public wxGISCommand
{
    DECLARE_DYNAMIC_CLASS(wxGISCommonCmd)

public:
    wxGISCommonCmd(void);
    virtual ~wxGISCommonCmd(void);
    //wxGISCommand
    virtual wxIcon GetBitmap(void);
    virtual wxString GetCaption(void);
    virtual wxString GetCategory(void);
    virtual bool GetChecked(void);
    virtual bool GetEnabled(void);
    virtual wxString GetMessage(void);
    virtual wxGISEnumCommandKind GetKind(void);
    virtual void OnClick(void);
    virtual bool OnCreate(wxGISApplicationBase* pApp);
    virtual wxString GetTooltip(void);
    virtual unsigned char GetCount(void);
private:
    wxGISApplicationBase* m_pApp;
    wxIcon m_IconOpt;
};