// Author: Benjamin I. Williams
// Modified by:
// Created: 2008-08-04
-// RCS-ID: $Id: framemanager.h 53135 2008-04-12 02:31:04Z VZ $
+// RCS-ID: $Id$
// Copyright: (C) Copyright 2005, Kirix Corporation, All Rights Reserved.
// Licence: wxWindows Library Licence, Version 3.1
///////////////////////////////////////////////////////////////////////////////
-
-
#ifndef _WX_AUIBAR_H_
#define _WX_AUIBAR_H_
-
#include "wx/defs.h"
#if wxUSE_AUI
+#include "wx/control.h"
+#include "wx/sizer.h"
+#include "wx/pen.h"
+
+class WXDLLIMPEXP_FWD_CORE wxClientDC;
+class WXDLLIMPEXP_FWD_AUI wxAuiPaneInfo;
enum wxAuiToolBarStyle
{
wxAUI_TB_NO_AUTORESIZE = 1 << 2,
wxAUI_TB_GRIPPER = 1 << 3,
wxAUI_TB_OVERFLOW = 1 << 4,
+ // using this style forces the toolbar to be vertical and
+ // be only dockable to the left or right sides of the window
+ // whereas by default it can be horizontal or vertical and
+ // be docked anywhere
wxAUI_TB_VERTICAL = 1 << 5,
- wxAUI_TB_HORZ_TEXT = ((1 << 6) | wxAUI_TB_TEXT),
+ wxAUI_TB_HORZ_LAYOUT = 1 << 6,
+ // analogous to wxAUI_TB_VERTICAL, but forces the toolbar
+ // to be horizontal
+ wxAUI_TB_HORIZONTAL = 1 << 7,
+ wxAUI_TB_HORZ_TEXT = (wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_TEXT),
+ wxAUI_ORIENTATION_MASK = (wxAUI_TB_VERTICAL | wxAUI_TB_HORIZONTAL),
wxAUI_TB_DEFAULT_STYLE = 0
};
bool IsDropDownClicked() const { return is_dropdown_clicked; }
void SetDropDownClicked(bool c) { is_dropdown_clicked = c; }
-
+
wxPoint GetClickPoint() const { return click_pt; }
void SetClickPoint(const wxPoint& p) { click_pt = p; }
-
+
wxRect GetItemRect() const { return rect; }
void SetItemRect(const wxRect& r) { rect = r; }
-
+
int GetToolId() const { return tool_id; }
- void SetToolId(int id) { tool_id = id; }
-
-public:
+ void SetToolId(int toolid) { tool_id = toolid; }
+
+private:
+
bool is_dropdown_clicked;
wxPoint click_pt;
wxRect rect;
int tool_id;
-
-#ifndef SWIG
+
private:
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiToolBarEvent)
-#endif
};
class WXDLLIMPEXP_AUI wxAuiToolBarItem
{
+ friend class wxAuiToolBar;
+
public:
wxAuiToolBarItem()
{
window = NULL;
sizer_item = NULL;
- space_pixels = 0;
- id = 0;
+ spacer_pixels = 0;
+ toolid = 0;
kind = wxITEM_NORMAL;
state = 0; // normal, enabled
proportion = 0;
dropdown = true;
sticky = true;
user_data = 0;
+ alignment = wxALIGN_CENTER;
}
-
+
wxAuiToolBarItem(const wxAuiToolBarItem& c)
{
Assign(c);
}
-
+
wxAuiToolBarItem& operator=(const wxAuiToolBarItem& c)
{
Assign(c);
return *this;
}
-
+
void Assign(const wxAuiToolBarItem& c)
{
window = c.window;
long_help = c.long_help;
sizer_item = c.sizer_item;
min_size = c.min_size;
- space_pixels = c.space_pixels;
- id = c.id;
+ spacer_pixels = c.spacer_pixels;
+ toolid = c.toolid;
kind = c.kind;
state = c.state;
proportion = c.proportion;
dropdown = c.dropdown;
sticky = c.sticky;
user_data = c.user_data;
+ alignment = c.alignment;
}
-
-public:
-
+
+
+ void SetWindow(wxWindow* w) { window = w; }
+ wxWindow* GetWindow() { return window; }
+
+ void SetId(int new_id) { toolid = new_id; }
+ int GetId() const { return toolid; }
+
+ void SetKind(int new_kind) { kind = new_kind; }
+ int GetKind() const { return kind; }
+
+ void SetState(int new_state) { state = new_state; }
+ int GetState() const { return state; }
+
+ void SetSizerItem(wxSizerItem* s) { sizer_item = s; }
+ wxSizerItem* GetSizerItem() const { return sizer_item; }
+
+ void SetLabel(const wxString& s) { label = s; }
+ const wxString& GetLabel() const { return label; }
+
+ void SetBitmap(const wxBitmap& bmp) { bitmap = bmp; }
+ const wxBitmap& GetBitmap() const { return bitmap; }
+
+ void SetDisabledBitmap(const wxBitmap& bmp) { disabled_bitmap = bmp; }
+ const wxBitmap& GetDisabledBitmap() const { return disabled_bitmap; }
+
+ void SetHoverBitmap(const wxBitmap& bmp) { hover_bitmap = bmp; }
+ const wxBitmap& GetHoverBitmap() const { return hover_bitmap; }
+
+ void SetShortHelp(const wxString& s) { short_help = s; }
+ const wxString& GetShortHelp() const { return short_help; }
+
+ void SetLongHelp(const wxString& s) { long_help = s; }
+ const wxString& GetLongHelp() const { return long_help; }
+
+ void SetMinSize(const wxSize& s) { min_size = s; }
+ const wxSize& GetMinSize() const { return min_size; }
+
+ void SetSpacerPixels(int s) { spacer_pixels = s; }
+ int GetSpacerPixels() const { return spacer_pixels; }
+
+ void SetProportion(int p) { proportion = p; }
+ int GetProportion() const { return proportion; }
+
+ void SetActive(bool b) { active = b; }
+ bool IsActive() const { return active; }
+
+ void SetHasDropDown(bool b) { dropdown = b; }
+ bool HasDropDown() const { return dropdown; }
+
+ void SetSticky(bool b) { sticky = b; }
+ bool IsSticky() const { return sticky; }
+
+ void SetUserData(long l) { user_data = l; }
+ long GetUserData() const { return user_data; }
+
+ void SetAlignment(int l) { alignment = l; }
+ int GetAlignment() const { return alignment; }
+
+private:
+
wxWindow* window; // item's associated window
wxString label; // label displayed on the item
wxBitmap bitmap; // item's bitmap
wxString long_help; // long help (for status bar)
wxSizerItem* sizer_item; // sizer item
wxSize min_size; // item's minimum size
- int space_pixels; // size of a spacer
- int id; // item's id
+ int spacer_pixels; // size of a spacer
+ int toolid; // item's id
int kind; // item's kind
int state; // state
int proportion; // proportion
bool dropdown; // true if the item has a dropdown button
bool sticky; // overrides button states if true (always active)
long user_data; // user-specified data
+ int alignment; // sizer alignment flag, defaults to wxCENTER, may be wxEXPAND or any other
};
#ifndef SWIG
wxAuiToolBarArt() { }
virtual ~wxAuiToolBarArt() { }
-
+
virtual wxAuiToolBarArt* Clone() = 0;
- virtual void SetFlags(unsigned int flags) = 0;
+ virtual void SetFlags(unsigned int flags) = 0;
+ virtual unsigned int GetFlags() = 0;
virtual void SetFont(const wxFont& font) = 0;
+ virtual wxFont GetFont() = 0;
virtual void SetTextOrientation(int orientation) = 0;
+ virtual int GetTextOrientation() = 0;
virtual void DrawBackground(
wxDC& dc,
wxWindow* wnd,
- const wxRect& rect) = 0;
-
+ const wxRect& rect) = 0;
+
virtual void DrawLabel(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect) = 0;
-
+
virtual void DrawButton(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect) = 0;
-
+
virtual void DrawDropDownButton(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect) = 0;
-
+
virtual void DrawControlLabel(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect) = 0;
-
+
virtual void DrawSeparator(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect) = 0;
-
+
virtual void DrawGripper(
wxDC& dc,
wxWindow* wnd,
wxWindow* wnd,
const wxRect& rect,
int state) = 0;
-
+
virtual wxSize GetLabelSize(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item) = 0;
-
+
virtual wxSize GetToolSize(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item) = 0;
-
+
virtual int GetElementSize(int element_id) = 0;
virtual void SetElementSize(int element_id, int size) = 0;
-
+
virtual int ShowDropDown(
wxWindow* wnd,
const wxAuiToolBarItemArray& items) = 0;
wxAuiDefaultToolBarArt();
virtual ~wxAuiDefaultToolBarArt();
-
+
virtual wxAuiToolBarArt* Clone();
virtual void SetFlags(unsigned int flags);
+ virtual unsigned int GetFlags();
virtual void SetFont(const wxFont& font);
+ virtual wxFont GetFont();
virtual void SetTextOrientation(int orientation);
+ virtual int GetTextOrientation();
virtual void DrawBackground(
wxDC& dc,
wxWindow* wnd,
- const wxRect& rect);
-
+ const wxRect& rect);
+
virtual void DrawLabel(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect);
-
+
virtual void DrawButton(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect);
-
+
virtual void DrawDropDownButton(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect);
-
+
virtual void DrawControlLabel(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item,
const wxRect& rect);
-
+
virtual void DrawSeparator(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
-
+
virtual void DrawGripper(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
-
+
virtual void DrawOverflowButton(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
int state);
-
+
virtual wxSize GetLabelSize(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item);
-
+
virtual wxSize GetToolSize(
wxDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item);
-
+
virtual int GetElementSize(int element);
virtual void SetElementSize(int element_id, int size);
wxFont m_font;
unsigned int m_flags;
int m_text_orientation;
-
+
wxPen m_gripper_pen1;
wxPen m_gripper_pen2;
wxPen m_gripper_pen3;
-
+
int m_separator_size;
int m_gripper_size;
int m_overflow_size;
const wxPoint& position = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxAUI_TB_DEFAULT_STYLE);
- ~wxAuiToolBar();
-
+ virtual ~wxAuiToolBar();
+
void SetWindowStyleFlag(long style);
-
+ long GetWindowStyleFlag() const;
+
void SetArtProvider(wxAuiToolBarArt* art);
wxAuiToolBarArt* GetArtProvider() const;
bool SetFont(const wxFont& font);
-
- void AddTool(int tool_id,
+
+ wxAuiToolBarItem* AddTool(int tool_id,
const wxString& label,
const wxBitmap& bitmap,
const wxString& short_help_string = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL);
-
- void AddTool(int tool_id,
+
+ wxAuiToolBarItem* AddTool(int tool_id,
const wxString& label,
const wxBitmap& bitmap,
const wxBitmap& disabled_bitmap,
const wxString& short_help_string,
const wxString& long_help_string,
wxObject* client_data);
-
- void AddTool(int tool_id,
+
+ wxAuiToolBarItem* AddTool(int tool_id,
const wxBitmap& bitmap,
const wxBitmap& disabled_bitmap,
bool toggle = false,
const wxString& short_help_string = wxEmptyString,
const wxString& long_help_string = wxEmptyString)
{
- AddTool(tool_id,
+ return AddTool(tool_id,
wxEmptyString,
bitmap,
disabled_bitmap,
long_help_string,
client_data);
}
-
- void AddLabel(int tool_id,
+
+ wxAuiToolBarItem* AddLabel(int tool_id,
const wxString& label = wxEmptyString,
const int width = -1);
- void AddControl(wxControl* control,
+ wxAuiToolBarItem* AddControl(wxControl* control,
const wxString& label = wxEmptyString);
- void AddSeparator();
- void AddSpacer(int pixels);
- void AddStretchSpacer(int proportion = 1);
-
+ wxAuiToolBarItem* AddSeparator();
+ wxAuiToolBarItem* AddSpacer(int pixels);
+ wxAuiToolBarItem* AddStretchSpacer(int proportion = 1);
+
bool Realize();
wxControl* FindControl(int window_id);
wxAuiToolBarItem* FindToolByPosition(wxCoord x, wxCoord y) const;
wxAuiToolBarItem* FindToolByIndex(int idx) const;
wxAuiToolBarItem* FindTool(int tool_id) const;
-
+
void ClearTools() { Clear() ; }
void Clear();
bool DeleteTool(int tool_id);
bool DeleteByIndex(int tool_id);
-
+
size_t GetToolCount() const;
int GetToolPos(int tool_id) const { return GetToolIndex(tool_id); }
int GetToolIndex(int tool_id) const;
bool GetToolFits(int tool_id) const;
wxRect GetToolRect(int tool_id) const;
- bool GetToolFitsByIndex(int tool_id) const;
+ bool GetToolFitsByIndex(int tool_id) const;
bool GetToolBarFits() const;
-
+
void SetMargins(const wxSize& size) { SetMargins(size.x, size.x, size.y, size.y); }
void SetMargins(int x, int y) { SetMargins(x, x, y, y); }
void SetMargins(int left, int right, int top, int bottom);
-
+
void SetToolBitmapSize(const wxSize& size);
wxSize GetToolBitmapSize() const;
bool GetOverflowVisible() const;
void SetOverflowVisible(bool visible);
-
+
bool GetGripperVisible() const;
void SetGripperVisible(bool visible);
-
+
void ToggleTool(int tool_id, bool state);
bool GetToolToggled(int tool_id) const;
-
+
void EnableTool(int tool_id, bool state);
bool GetToolEnabled(int tool_id) const;
-
+
void SetToolDropDown(int tool_id, bool dropdown);
bool GetToolDropDown(int tool_id) const;
void SetToolBorderPadding(int padding);
int GetToolBorderPadding() const;
-
+
void SetToolTextOrientation(int orientation);
int GetToolTextOrientation() const;
-
+
void SetToolPacking(int packing);
int GetToolPacking() const;
-
+
void SetToolProportion(int tool_id, int proportion);
int GetToolProportion(int tool_id) const;
-
+
void SetToolSeparation(int separation);
int GetToolSeparation() const;
-
+
void SetToolSticky(int tool_id, bool sticky);
bool GetToolSticky(int tool_id) const;
-
+
wxString GetToolLabel(int tool_id) const;
void SetToolLabel(int tool_id, const wxString& label);
-
+
wxBitmap GetToolBitmap(int tool_id) const;
void SetToolBitmap(int tool_id, const wxBitmap& bitmap);
-
+
wxString GetToolShortHelp(int tool_id) const;
void SetToolShortHelp(int tool_id, const wxString& help_string);
-
+
wxString GetToolLongHelp(int tool_id) const;
void SetToolLongHelp(int tool_id, const wxString& help_string);
-
+
void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend,
const wxAuiToolBarItemArray& append);
-
+
+ // get size of hint rectangle for a particular dock location
+ wxSize GetHintSize(int dock_direction) const;
+ bool IsPaneValid(const wxAuiPaneInfo& pane) const;
+
protected:
virtual void OnCustomRender(wxDC& WXUNUSED(dc),
void SetHoverItem(wxAuiToolBarItem* item);
void SetPressedItem(wxAuiToolBarItem* item);
void RefreshOverflowState();
-
+
int GetOverflowState() const;
wxRect GetOverflowRect() const;
wxSize GetLabelSize(const wxString& label);
int width,
int height,
int sizeFlags = wxSIZE_AUTO);
-
+
protected: // handlers
void OnSize(wxSizeEvent& evt);
void OnMiddleUp(wxMouseEvent& evt);
void OnMotion(wxMouseEvent& evt);
void OnLeaveWindow(wxMouseEvent& evt);
+ void OnCaptureLost(wxMouseCaptureLostEvent& evt);
void OnSetCursor(wxSetCursorEvent& evt);
-
+
protected:
wxAuiToolBarItemArray m_items; // array of toolbar items
wxPoint m_action_pos; // position of left-mouse down
wxAuiToolBarItemArray m_custom_overflow_prepend;
wxAuiToolBarItemArray m_custom_overflow_append;
-
+
int m_button_width;
int m_button_height;
int m_sizer_element_count;
bool m_gripper_visible;
bool m_overflow_visible;
long m_style;
-
+
+ bool RealizeHelper(wxClientDC& dc, bool horizontal);
+ static bool IsPaneValid(long style, const wxAuiPaneInfo& pane);
+ bool IsPaneValid(long style) const;
+ void SetArtFlags() const;
+ wxOrientation m_orientation;
+ wxSize m_horzHintSize;
+ wxSize m_vertHintSize;
+
+private:
+ // Common part of OnLeaveWindow() and OnCaptureLost().
+ void DoResetMouseState();
+
DECLARE_EVENT_TABLE()
DECLARE_CLASS(wxAuiToolBar)
};
#ifndef SWIG
-BEGIN_DECLARE_EVENT_TYPES()
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_TOOL_DROPDOWN, 0)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_OVERFLOW_CLICK, 0)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_RIGHT_CLICK, 0)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_MIDDLE_CLICK, 0)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_BEGIN_DRAG, 0)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_TOOL_DROPDOWN, wxAuiToolBarEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_OVERFLOW_CLICK, wxAuiToolBarEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_RIGHT_CLICK, wxAuiToolBarEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_MIDDLE_CLICK, wxAuiToolBarEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUITOOLBAR_BEGIN_DRAG, wxAuiToolBarEvent );
typedef void (wxEvtHandler::*wxAuiToolBarEventFunction)(wxAuiToolBarEvent&);
#define wxAuiToolBarEventHandler(func) \
- (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiToolBarEventFunction, &func)
-
+ wxEVENT_HANDLER_CAST(wxAuiToolBarEventFunction, func)
+
#define EVT_AUITOOLBAR_TOOL_DROPDOWN(winid, fn) \
wx__DECLARE_EVT1(wxEVT_COMMAND_AUITOOLBAR_TOOL_DROPDOWN, winid, wxAuiToolBarEventHandler(fn))
#define EVT_AUITOOLBAR_OVERFLOW_CLICK(winid, fn) \
projects / wxWidgets.git / blobdiff