258 lines
9.2 KiB
C++
258 lines
9.2 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/ribbon/toolbar.h
|
|
// Purpose: Ribbon-style tool bar
|
|
// Author: Peter Cawley
|
|
// Modified by:
|
|
// Created: 2009-07-06
|
|
// Copyright: (C) Peter Cawley
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
#ifndef _WX_RIBBON_TOOLBAR_H_
|
|
#define _WX_RIBBON_TOOLBAR_H_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_RIBBON
|
|
|
|
#include "wx/ribbon/control.h"
|
|
#include "wx/ribbon/art.h"
|
|
|
|
class wxRibbonToolBarToolBase;
|
|
class wxRibbonToolBarToolGroup;
|
|
WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxRibbonToolBarToolGroup*, wxArrayRibbonToolBarToolGroup, class WXDLLIMPEXP_RIBBON);
|
|
|
|
enum wxRibbonToolBarToolState
|
|
{
|
|
wxRIBBON_TOOLBAR_TOOL_FIRST = 1 << 0,
|
|
wxRIBBON_TOOLBAR_TOOL_LAST = 1 << 1,
|
|
wxRIBBON_TOOLBAR_TOOL_POSITION_MASK = wxRIBBON_TOOLBAR_TOOL_FIRST | wxRIBBON_TOOLBAR_TOOL_LAST,
|
|
|
|
wxRIBBON_TOOLBAR_TOOL_NORMAL_HOVERED = 1 << 3,
|
|
wxRIBBON_TOOLBAR_TOOL_DROPDOWN_HOVERED = 1 << 4,
|
|
wxRIBBON_TOOLBAR_TOOL_HOVER_MASK = wxRIBBON_TOOLBAR_TOOL_NORMAL_HOVERED | wxRIBBON_TOOLBAR_TOOL_DROPDOWN_HOVERED,
|
|
wxRIBBON_TOOLBAR_TOOL_NORMAL_ACTIVE = 1 << 5,
|
|
wxRIBBON_TOOLBAR_TOOL_DROPDOWN_ACTIVE = 1 << 6,
|
|
wxRIBBON_TOOLBAR_TOOL_ACTIVE_MASK = wxRIBBON_TOOLBAR_TOOL_NORMAL_ACTIVE | wxRIBBON_TOOLBAR_TOOL_DROPDOWN_ACTIVE,
|
|
wxRIBBON_TOOLBAR_TOOL_DISABLED = 1 << 7,
|
|
wxRIBBON_TOOLBAR_TOOL_TOGGLED = 1 << 8,
|
|
wxRIBBON_TOOLBAR_TOOL_STATE_MASK = 0x1F8
|
|
};
|
|
|
|
|
|
class WXDLLIMPEXP_RIBBON wxRibbonToolBar : public wxRibbonControl
|
|
{
|
|
public:
|
|
wxRibbonToolBar();
|
|
|
|
wxRibbonToolBar(wxWindow* parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0);
|
|
|
|
virtual ~wxRibbonToolBar();
|
|
|
|
bool Create(wxWindow* parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = 0);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddTool(
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string,
|
|
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddDropdownTool(
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddHybridTool(
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddToggleTool(
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddTool(
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxBitmap& bitmap_disabled = wxNullBitmap,
|
|
const wxString& help_string = wxEmptyString,
|
|
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
|
|
wxObject* client_data = NULL);
|
|
|
|
virtual wxRibbonToolBarToolBase* AddSeparator();
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertTool(
|
|
size_t pos,
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string,
|
|
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL);
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertDropdownTool(
|
|
size_t pos,
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertHybridTool(
|
|
size_t pos,
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertToggleTool(
|
|
size_t pos,
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxString& help_string = wxEmptyString);
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertTool(
|
|
size_t pos,
|
|
int tool_id,
|
|
const wxBitmap& bitmap,
|
|
const wxBitmap& bitmap_disabled = wxNullBitmap,
|
|
const wxString& help_string = wxEmptyString,
|
|
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
|
|
wxObject* client_data = NULL);
|
|
|
|
virtual wxRibbonToolBarToolBase* InsertSeparator(size_t pos);
|
|
|
|
virtual void ClearTools();
|
|
virtual bool DeleteTool(int tool_id);
|
|
virtual bool DeleteToolByPos(size_t pos);
|
|
|
|
virtual wxRibbonToolBarToolBase* FindById(int tool_id)const;
|
|
virtual wxRibbonToolBarToolBase* GetToolByPos(size_t pos)const;
|
|
virtual size_t GetToolCount() const;
|
|
virtual int GetToolId(const wxRibbonToolBarToolBase* tool)const;
|
|
|
|
virtual wxObject* GetToolClientData(int tool_id)const;
|
|
virtual bool GetToolEnabled(int tool_id)const;
|
|
virtual wxString GetToolHelpString(int tool_id)const;
|
|
virtual wxRibbonButtonKind GetToolKind(int tool_id)const;
|
|
virtual int GetToolPos(int tool_id)const;
|
|
virtual bool GetToolState(int tool_id)const;
|
|
|
|
virtual bool Realize() wxOVERRIDE;
|
|
virtual void SetRows(int nMin, int nMax = -1);
|
|
|
|
virtual void SetToolClientData(int tool_id, wxObject* clientData);
|
|
virtual void SetToolDisabledBitmap(int tool_id, const wxBitmap &bitmap);
|
|
virtual void SetToolHelpString(int tool_id, const wxString& helpString);
|
|
virtual void SetToolNormalBitmap(int tool_id, const wxBitmap &bitmap);
|
|
|
|
virtual bool IsSizingContinuous() const wxOVERRIDE;
|
|
|
|
virtual void EnableTool(int tool_id, bool enable = true);
|
|
virtual void ToggleTool(int tool_id, bool checked);
|
|
|
|
// Finds the best width and height given the parent's width and height
|
|
virtual wxSize GetBestSizeForParentSize(const wxSize& parentSize) const wxOVERRIDE;
|
|
|
|
protected:
|
|
friend class wxRibbonToolBarEvent;
|
|
virtual wxSize DoGetBestSize() const wxOVERRIDE;
|
|
wxBorder GetDefaultBorder() const wxOVERRIDE { return wxBORDER_NONE; }
|
|
|
|
void OnEraseBackground(wxEraseEvent& evt);
|
|
void OnMouseDown(wxMouseEvent& evt);
|
|
void OnMouseEnter(wxMouseEvent& evt);
|
|
void OnMouseLeave(wxMouseEvent& evt);
|
|
void OnMouseMove(wxMouseEvent& evt);
|
|
void OnMouseUp(wxMouseEvent& evt);
|
|
void OnPaint(wxPaintEvent& evt);
|
|
void OnSize(wxSizeEvent& evt);
|
|
|
|
virtual wxSize DoGetNextSmallerSize(wxOrientation direction,
|
|
wxSize relative_to) const wxOVERRIDE;
|
|
virtual wxSize DoGetNextLargerSize(wxOrientation direction,
|
|
wxSize relative_to) const wxOVERRIDE;
|
|
|
|
void CommonInit(long style);
|
|
void AppendGroup();
|
|
wxRibbonToolBarToolGroup* InsertGroup(size_t pos);
|
|
virtual void UpdateWindowUI(long flags) wxOVERRIDE;
|
|
|
|
static wxBitmap MakeDisabledBitmap(const wxBitmap& original);
|
|
|
|
wxArrayRibbonToolBarToolGroup m_groups;
|
|
wxRibbonToolBarToolBase* m_hover_tool;
|
|
wxRibbonToolBarToolBase* m_active_tool;
|
|
wxSize* m_sizes;
|
|
int m_nrows_min;
|
|
int m_nrows_max;
|
|
|
|
#ifndef SWIG
|
|
wxDECLARE_CLASS(wxRibbonToolBar);
|
|
wxDECLARE_EVENT_TABLE();
|
|
#endif
|
|
};
|
|
|
|
|
|
class WXDLLIMPEXP_RIBBON wxRibbonToolBarEvent : public wxCommandEvent
|
|
{
|
|
public:
|
|
wxRibbonToolBarEvent(wxEventType command_type = wxEVT_NULL,
|
|
int win_id = 0,
|
|
wxRibbonToolBar* bar = NULL)
|
|
: wxCommandEvent(command_type, win_id)
|
|
, m_bar(bar)
|
|
{
|
|
}
|
|
wxEvent *Clone() const wxOVERRIDE { return new wxRibbonToolBarEvent(*this); }
|
|
|
|
wxRibbonToolBar* GetBar() {return m_bar;}
|
|
void SetBar(wxRibbonToolBar* bar) {m_bar = bar;}
|
|
bool PopupMenu(wxMenu* menu);
|
|
|
|
protected:
|
|
wxRibbonToolBar* m_bar;
|
|
|
|
#ifndef SWIG
|
|
private:
|
|
wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRibbonToolBarEvent);
|
|
#endif
|
|
};
|
|
|
|
#ifndef SWIG
|
|
|
|
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_RIBBONTOOLBAR_CLICKED, wxRibbonToolBarEvent);
|
|
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED, wxRibbonToolBarEvent);
|
|
|
|
typedef void (wxEvtHandler::*wxRibbonToolBarEventFunction)(wxRibbonToolBarEvent&);
|
|
|
|
#define wxRibbonToolBarEventHandler(func) \
|
|
wxEVENT_HANDLER_CAST(wxRibbonToolBarEventFunction, func)
|
|
|
|
#define EVT_RIBBONTOOLBAR_CLICKED(winid, fn) \
|
|
wx__DECLARE_EVT1(wxEVT_RIBBONTOOLBAR_CLICKED, winid, wxRibbonToolBarEventHandler(fn))
|
|
#define EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED(winid, fn) \
|
|
wx__DECLARE_EVT1(wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED, winid, wxRibbonToolBarEventHandler(fn))
|
|
#else
|
|
|
|
// wxpython/swig event work
|
|
%constant wxEventType wxEVT_RIBBONTOOLBAR_CLICKED;
|
|
%constant wxEventType wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED;
|
|
|
|
%pythoncode {
|
|
EVT_RIBBONTOOLBAR_CLICKED = wx.PyEventBinder( wxEVT_RIBBONTOOLBAR_CLICKED, 1 )
|
|
EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED = wx.PyEventBinder( wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED, 1 )
|
|
}
|
|
#endif
|
|
|
|
// old wxEVT_COMMAND_* constants
|
|
#define wxEVT_COMMAND_RIBBONTOOL_CLICKED wxEVT_RIBBONTOOLBAR_CLICKED
|
|
#define wxEVT_COMMAND_RIBBONTOOL_DROPDOWN_CLICKED wxEVT_RIBBONTOOLBAR_DROPDOWN_CLICKED
|
|
|
|
#endif // wxUSE_RIBBON
|
|
|
|
#endif // _WX_RIBBON_TOOLBAR_H_
|