git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: aui/dockart.h
	3	// Purpose: interface of wxAuiDockArt
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9
	10	/**
	11	@todo TOWRITE
	12	*/
	13	enum wxAuiPaneDockArtSetting
	14	{
	15	wxAUI_DOCKART_SASH_SIZE = 0,
	16	wxAUI_DOCKART_CAPTION_SIZE = 1,
	17	wxAUI_DOCKART_GRIPPER_SIZE = 2,
	18	wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
	19	wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
	20	wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
	21	wxAUI_DOCKART_SASH_COLOUR = 6,
	22	wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
	23	wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
	24	wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
	25	wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
	26	wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
	27	wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
	28	wxAUI_DOCKART_BORDER_COLOUR = 13,
	29	wxAUI_DOCKART_GRIPPER_COLOUR = 14,
	30	wxAUI_DOCKART_CAPTION_FONT = 15,
	31	wxAUI_DOCKART_GRADIENT_TYPE = 16
	32	};
	33
	34	/**
	35	@todo TOWRITE
	36	*/
	37	enum wxAuiPaneDockArtGradients
	38	{
	39	wxAUI_GRADIENT_NONE = 0,
	40	wxAUI_GRADIENT_VERTICAL = 1,
	41	wxAUI_GRADIENT_HORIZONTAL = 2
	42	};
	43
	44	/**
	45	@todo TOWRITE
	46	*/
	47	enum wxAuiPaneButtonState
	48	{
	49	wxAUI_BUTTON_STATE_NORMAL = 0,
	50	wxAUI_BUTTON_STATE_HOVER = 1,
	51	wxAUI_BUTTON_STATE_PRESSED = 2
	52	};
	53
	54	/**
	55	@todo TOWRITE
	56	*/
	57	enum wxAuiButtonId
	58	{
	59	wxAUI_BUTTON_CLOSE = 101,
	60	wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
	61	wxAUI_BUTTON_MINIMIZE = 103,
	62	wxAUI_BUTTON_PIN = 104,
	63	wxAUI_BUTTON_OPTIONS = 105,
	64	wxAUI_BUTTON_WINDOWLIST = 106,
	65	wxAUI_BUTTON_LEFT = 107,
	66	wxAUI_BUTTON_RIGHT = 108,
	67	wxAUI_BUTTON_UP = 109,
	68	wxAUI_BUTTON_DOWN = 110,
	69	wxAUI_BUTTON_CUSTOM1 = 201,
	70	wxAUI_BUTTON_CUSTOM2 = 202,
	71	wxAUI_BUTTON_CUSTOM3 = 203
	72	};
	73
	74	/**
	75	@class wxAuiDockArt
	76
	77	wxAuiDockArt is part of the wxAUI class framework.
	78	See also @ref overview_aui.
	79
	80	wxAuiDockArt is the art provider: provides all drawing functionality to the
	81	wxAui dock manager. This allows the dock manager to have a plugable look-and-feel.
	82
	83	By default, a wxAuiManager uses an instance of this class called
	84	wxAuiDefaultDockArt which provides bitmap art and a colour scheme that is
	85	adapted to the major platforms' look. You can either derive from that class
	86	to alter its behaviour or write a completely new dock art class.
	87	Call wxAuiManager::SetArtProvider to force wxAUI to use your new dock art provider.
	88
	89	@library{wxaui}
	90	@category{aui}
	91
	92	@see wxAuiManager, wxAuiPaneInfo
	93	*/
	94	class wxAuiDockArt
	95	{
	96	public:
	97	/**
	98	Constructor.
	99	*/
	100	wxAuiDockArt();
	101
	102	/**
	103	Destructor.
	104	*/
	105	virtual ~wxAuiDockArt();
	106
	107	/**
	108	Draws a background.
	109	*/
	110	virtual void DrawBackground(wxDC& dc, wxWindow* window, int orientation,
	111	const wxRect& rect) = 0;
	112
	113	/**
	114	Draws a border.
	115	*/
	116	virtual void DrawBorder(wxDC& dc, wxWindow* window, const wxRect& rect,
	117	wxAuiPaneInfo& pane) = 0;
	118
	119	/**
	120	Draws a caption.
	121	*/
	122	virtual void DrawCaption(wxDC& dc, wxWindow* window, const wxString& text,
	123	const wxRect& rect, wxAuiPaneInfo& pane) = 0;
	124
	125	/**
	126	Draws a gripper.
	127	*/
	128	virtual void DrawGripper(wxDC& dc, wxWindow* window, const wxRect& rect,
	129	wxAuiPaneInfo& pane) = 0;
	130
	131	/**
	132	Draws a button in the pane's title bar.
	133	@a button can be one of the values of @b wxAuiButtonId.
	134	@a button_state can be one of the values of @b wxAuiPaneButtonState.
	135	*/
	136	virtual void DrawPaneButton(wxDC& dc, wxWindow* window, int button,
	137	int button_state, const wxRect& rect,
	138	wxAuiPaneInfo& pane) = 0;
	139
	140	/**
	141	Draws a sash between two windows.
	142	*/
	143	virtual void DrawSash(wxDC& dc, wxWindow* window, int orientation,
	144	const wxRect& rect) = 0;
	145	/**
	146	Get the colour of a certain setting.
	147	@a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
	148	*/
	149	virtual wxColour GetColour(int id) = 0;
	150
	151	/**
	152	Get a font setting.
	153	*/
	154	virtual wxFont GetFont(int id) = 0;
	155
	156	/**
	157	Get the value of a certain setting.
	158	@a id can be one of the size values of @b wxAuiPaneDockArtSetting.
	159	*/
	160	virtual int GetMetric(int id) = 0;
	161
	162	/**
	163	Set a certain setting with the value @e colour.
	164	@a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
	165	*/
	166	virtual void SetColour(int id, const wxColour& colour) = 0;
	167
	168	/**
	169	Set a font setting.
	170	*/
	171	virtual void SetFont(int id, const wxFont& font) = 0;
	172
	173	/**
	174	Set a certain setting with the value @e new_val.
	175	@a id can be one of the size values of @b wxAuiPaneDockArtSetting.
	176	*/
	177	virtual void SetMetric(int id, int new_val) = 0;
	178	};
	179