]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/tbarbase.h
added wxTextCtrl::HitTest(); implemented it for MSW
[wxWidgets.git] / include / wx / tbarbase.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/tbarbase.h
3// Purpose: Base class for toolbar classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_TBARBASE_H_
13#define _WX_TBARBASE_H_
14
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma interface "tbarbase.h"
21#endif
22
23#include "wx/defs.h"
24
25#if wxUSE_TOOLBAR
26
27#include "wx/bitmap.h"
28#include "wx/list.h"
29#include "wx/control.h"
30
31class WXDLLEXPORT wxToolBarBase;
32class WXDLLEXPORT wxToolBarToolBase;
33class WXDLLEXPORT wxImage;
34
35// ----------------------------------------------------------------------------
36// constants
37// ----------------------------------------------------------------------------
38
39WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
40WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
41WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
42
43enum wxToolBarToolStyle
44{
45 wxTOOL_STYLE_BUTTON = 1,
46 wxTOOL_STYLE_SEPARATOR = 2,
47 wxTOOL_STYLE_CONTROL
48};
49
50// ----------------------------------------------------------------------------
51// wxToolBarTool is a toolbar element.
52//
53// It has a unique id (except for the separators which always have id -1), the
54// style (telling whether it is a normal button, separator or a control), the
55// state (toggled or not, enabled or not) and short and long help strings. The
56// default implementations use the short help string for the tooltip text which
57// is popped up when the mouse pointer enters the tool and the long help string
58// for the applications status bar.
59// ----------------------------------------------------------------------------
60
61class WXDLLEXPORT wxToolBarToolBase : public wxObject
62{
63public:
64 // ctors & dtor
65 // ------------
66
67 wxToolBarToolBase(wxToolBarBase *tbar = (wxToolBarBase *)NULL,
68 int toolid = wxID_SEPARATOR,
69 const wxString& label = wxEmptyString,
70 const wxBitmap& bmpNormal = wxNullBitmap,
71 const wxBitmap& bmpDisabled = wxNullBitmap,
72 wxItemKind kind = wxITEM_NORMAL,
73 wxObject *clientData = (wxObject *) NULL,
74 const wxString& shortHelpString = wxEmptyString,
75 const wxString& longHelpString = wxEmptyString)
76 : m_label(label),
77 m_shortHelpString(shortHelpString),
78 m_longHelpString(longHelpString)
79 {
80 m_tbar = tbar;
81 m_id = toolid;
82 m_clientData = clientData;
83
84 m_bmpNormal = bmpNormal;
85 m_bmpDisabled = bmpDisabled;
86
87 m_kind = kind;
88
89 m_enabled = TRUE;
90 m_toggled = FALSE;
91
92 m_toolStyle = toolid == wxID_SEPARATOR ? wxTOOL_STYLE_SEPARATOR
93 : wxTOOL_STYLE_BUTTON;
94 }
95
96 wxToolBarToolBase(wxToolBarBase *tbar, wxControl *control)
97 {
98 m_tbar = tbar;
99 m_control = control;
100 m_id = control->GetId();
101
102 m_kind = wxITEM_MAX; // invalid value
103
104 m_enabled = TRUE;
105 m_toggled = FALSE;
106
107 m_toolStyle = wxTOOL_STYLE_CONTROL;
108 }
109
110 ~wxToolBarToolBase();
111
112 // accessors
113 // ---------
114
115 // general
116 int GetId() const { return m_id; }
117
118 wxControl *GetControl() const
119 {
120 wxASSERT_MSG( IsControl(), _T("this toolbar tool is not a control") );
121
122 return m_control;
123 }
124
125 wxToolBarBase *GetToolBar() const { return m_tbar; }
126
127 // style
128 bool IsButton() const { return m_toolStyle == wxTOOL_STYLE_BUTTON; }
129 bool IsControl() const { return m_toolStyle == wxTOOL_STYLE_CONTROL; }
130 bool IsSeparator() const { return m_toolStyle == wxTOOL_STYLE_SEPARATOR; }
131 int GetStyle() const { return m_toolStyle; }
132 wxItemKind GetKind() const
133 {
134 wxASSERT_MSG( IsButton(), _T("only makes sense for buttons") );
135
136 return m_kind;
137 }
138
139 // state
140 bool IsEnabled() const { return m_enabled; }
141 bool IsToggled() const { return m_toggled; }
142 bool CanBeToggled() const
143 { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; }
144
145 // attributes
146 const wxBitmap& GetNormalBitmap() const { return m_bmpNormal; }
147 const wxBitmap& GetDisabledBitmap() const { return m_bmpDisabled; }
148
149 const wxBitmap& GetBitmap() const
150 { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
151
152 wxString GetLabel() const { return m_label; }
153
154 wxString GetShortHelp() const { return m_shortHelpString; }
155 wxString GetLongHelp() const { return m_longHelpString; }
156
157 wxObject *GetClientData() const
158 {
159 if ( m_toolStyle == wxTOOL_STYLE_CONTROL )
160 {
161 return (wxObject*)m_control->GetClientData();
162 }
163 else
164 {
165 return m_clientData;
166 }
167 }
168
169 // modifiers: return TRUE if the state really changed
170 bool Enable(bool enable);
171 bool Toggle(bool toggle);
172 bool SetToggle(bool toggle);
173 bool SetShortHelp(const wxString& help);
174 bool SetLongHelp(const wxString& help);
175
176 void Toggle() { Toggle(!IsToggled()); }
177
178 void SetNormalBitmap(const wxBitmap& bmp) { m_bmpNormal = bmp; }
179 void SetDisabledBitmap(const wxBitmap& bmp) { m_bmpDisabled = bmp; }
180
181 virtual void SetLabel(const wxString& label) { m_label = label; }
182
183 void SetClientData(wxObject *clientData)
184 {
185 if ( m_toolStyle == wxTOOL_STYLE_CONTROL )
186 {
187 m_control->SetClientData(clientData);
188 }
189 else
190 {
191 m_clientData = clientData;
192 }
193 }
194
195 // add tool to/remove it from a toolbar
196 virtual void Detach() { m_tbar = (wxToolBarBase *)NULL; }
197 virtual void Attach(wxToolBarBase *tbar) { m_tbar = tbar; }
198
199 // compatibility only, don't use
200#if WXWIN_COMPATIBILITY_2_2
201 const wxBitmap& GetBitmap1() const { return GetNormalBitmap(); }
202 const wxBitmap& GetBitmap2() const { return GetDisabledBitmap(); }
203
204 void SetBitmap1(const wxBitmap& bmp) { SetNormalBitmap(bmp); }
205 void SetBitmap2(const wxBitmap& bmp) { SetDisabledBitmap(bmp); }
206#endif // WXWIN_COMPATIBILITY_2_2
207
208protected:
209 wxToolBarBase *m_tbar; // the toolbar to which we belong (may be NULL)
210
211 // tool parameters
212 int m_toolStyle; // see enum wxToolBarToolStyle
213 int m_id; // the tool id, wxID_SEPARATOR for separator
214 wxItemKind m_kind; // for normal buttons may be wxITEM_NORMAL/CHECK/RADIO
215
216 // as controls have their own client data, no need to waste memory
217 union
218 {
219 wxObject *m_clientData;
220 wxControl *m_control;
221 };
222
223 // tool state
224 bool m_toggled;
225 bool m_enabled;
226
227 // normal and disabled bitmaps for the tool, both can be invalid
228 wxBitmap m_bmpNormal;
229 wxBitmap m_bmpDisabled;
230
231 // the button label
232 wxString m_label;
233
234 // short and long help strings
235 wxString m_shortHelpString;
236 wxString m_longHelpString;
237
238 DECLARE_DYNAMIC_CLASS_NO_COPY(wxToolBarToolBase)
239};
240
241// a list of toolbar tools
242WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase, wxToolBarToolsList);
243
244// ----------------------------------------------------------------------------
245// the base class for all toolbars
246// ----------------------------------------------------------------------------
247
248class WXDLLEXPORT wxToolBarBase : public wxControl
249{
250public:
251 wxToolBarBase();
252 virtual ~wxToolBarBase();
253
254 // toolbar construction
255 // --------------------
256
257 // the full AddTool() function
258 //
259 // If bmpDisabled is wxNullBitmap, a shadowed version of the normal bitmap
260 // is created and used as the disabled image.
261 wxToolBarToolBase *AddTool(int toolid,
262 const wxString& label,
263 const wxBitmap& bitmap,
264 const wxBitmap& bmpDisabled,
265 wxItemKind kind = wxITEM_NORMAL,
266 const wxString& shortHelp = wxEmptyString,
267 const wxString& longHelp = wxEmptyString,
268 wxObject *data = NULL)
269 {
270 return DoAddTool(toolid, label, bitmap, bmpDisabled, kind,
271 shortHelp, longHelp, data);
272 }
273
274 // the most common AddTool() version
275 wxToolBarToolBase *AddTool(int toolid,
276 const wxString& label,
277 const wxBitmap& bitmap,
278 const wxString& shortHelp = wxEmptyString,
279 wxItemKind kind = wxITEM_NORMAL)
280 {
281 return AddTool(toolid, label, bitmap, wxNullBitmap, kind, shortHelp);
282 }
283
284 // add a check tool, i.e. a tool which can be toggled
285 wxToolBarToolBase *AddCheckTool(int toolid,
286 const wxString& label,
287 const wxBitmap& bitmap,
288 const wxBitmap& bmpDisabled = wxNullBitmap,
289 const wxString& shortHelp = wxEmptyString,
290 const wxString& longHelp = wxEmptyString,
291 wxObject *data = NULL)
292 {
293 return AddTool(toolid, label, bitmap, bmpDisabled, wxITEM_CHECK,
294 shortHelp, longHelp, data);
295 }
296
297 // add a radio tool, i.e. a tool which can be toggled and releases any
298 // other toggled radio tools in the same group when it happens
299 wxToolBarToolBase *AddRadioTool(int toolid,
300 const wxString& label,
301 const wxBitmap& bitmap,
302 const wxBitmap& bmpDisabled = wxNullBitmap,
303 const wxString& shortHelp = wxEmptyString,
304 const wxString& longHelp = wxEmptyString,
305 wxObject *data = NULL)
306 {
307 return AddTool(toolid, label, bitmap, bmpDisabled, wxITEM_RADIO,
308 shortHelp, longHelp, data);
309 }
310
311
312 // insert the new tool at the given position, if pos == GetToolsCount(), it
313 // is equivalent to AddTool()
314 virtual wxToolBarToolBase *InsertTool
315 (
316 size_t pos,
317 int toolid,
318 const wxString& label,
319 const wxBitmap& bitmap,
320 const wxBitmap& bmpDisabled = wxNullBitmap,
321 wxItemKind kind = wxITEM_NORMAL,
322 const wxString& shortHelp = wxEmptyString,
323 const wxString& longHelp = wxEmptyString,
324 wxObject *clientData = NULL
325 );
326
327 virtual wxToolBarToolBase *AddTool (wxToolBarToolBase *tool);
328 virtual wxToolBarToolBase *InsertTool (size_t pos, wxToolBarToolBase *tool);
329
330 // add an arbitrary control to the toolbar, return TRUE if ok (notice that
331 // the control will be deleted by the toolbar and that it will also adjust
332 // its position/size)
333 //
334 // NB: the control should have toolbar as its parent
335 virtual wxToolBarToolBase *AddControl(wxControl *control);
336 virtual wxToolBarToolBase *InsertControl(size_t pos, wxControl *control);
337
338 // get the control with the given id or return NULL
339 virtual wxControl *FindControl( int toolid );
340
341 // add a separator to the toolbar
342 virtual wxToolBarToolBase *AddSeparator();
343 virtual wxToolBarToolBase *InsertSeparator(size_t pos);
344
345 // remove the tool from the toolbar: the caller is responsible for actually
346 // deleting the pointer
347 virtual wxToolBarToolBase *RemoveTool(int toolid);
348
349 // delete tool either by index or by position
350 virtual bool DeleteToolByPos(size_t pos);
351 virtual bool DeleteTool(int toolid);
352
353 // delete all tools
354 virtual void ClearTools();
355
356 // must be called after all buttons have been created to finish toolbar
357 // initialisation
358 virtual bool Realize();
359
360 // tools state
361 // -----------
362
363 virtual void EnableTool(int toolid, bool enable);
364 virtual void ToggleTool(int toolid, bool toggle);
365
366 // Set this to be togglable (or not)
367 virtual void SetToggle(int toolid, bool toggle);
368
369 // set/get tools client data (not for controls)
370 virtual wxObject *GetToolClientData(int toolid) const;
371 virtual void SetToolClientData(int toolid, wxObject *clientData);
372
373 // returns tool pos, or wxNOT_FOUND if tool isn't found
374 virtual int GetToolPos(int id) const;
375
376 // return TRUE if the tool is toggled
377 virtual bool GetToolState(int toolid) const;
378
379 virtual bool GetToolEnabled(int toolid) const;
380
381 virtual void SetToolShortHelp(int toolid, const wxString& helpString);
382 virtual wxString GetToolShortHelp(int toolid) const;
383 virtual void SetToolLongHelp(int toolid, const wxString& helpString);
384 virtual wxString GetToolLongHelp(int toolid) const;
385
386 // margins/packing/separation
387 // --------------------------
388
389 virtual void SetMargins(int x, int y);
390 void SetMargins(const wxSize& size)
391 { SetMargins((int) size.x, (int) size.y); }
392 virtual void SetToolPacking(int packing)
393 { m_toolPacking = packing; }
394 virtual void SetToolSeparation(int separation)
395 { m_toolSeparation = separation; }
396
397 virtual wxSize GetToolMargins() const { return wxSize(m_xMargin, m_yMargin); }
398 virtual int GetToolPacking() const { return m_toolPacking; }
399 virtual int GetToolSeparation() const { return m_toolSeparation; }
400
401 // toolbar geometry
402 // ----------------
403
404 // set the number of toolbar rows
405 virtual void SetRows(int nRows);
406
407 // the toolbar can wrap - limit the number of columns or rows it may take
408 void SetMaxRowsCols(int rows, int cols)
409 { m_maxRows = rows; m_maxCols = cols; }
410 int GetMaxRows() const { return m_maxRows; }
411 int GetMaxCols() const { return m_maxCols; }
412
413 // get/set the size of the bitmaps used by the toolbar: should be called
414 // before adding any tools to the toolbar
415 virtual void SetToolBitmapSize(const wxSize& size)
416 { m_defaultWidth = size.x; m_defaultHeight = size.y; };
417 virtual wxSize GetToolBitmapSize() const
418 { return wxSize(m_defaultWidth, m_defaultHeight); }
419
420 // the button size in some implementations is bigger than the bitmap size:
421 // get the total button size (by default the same as bitmap size)
422 virtual wxSize GetToolSize() const
423 { return GetToolBitmapSize(); } ;
424
425 // returns a (non separator) tool containing the point (x, y) or NULL if
426 // there is no tool at this point (corrdinates are client)
427 virtual wxToolBarToolBase *FindToolForPosition(wxCoord x,
428 wxCoord y) const = 0;
429
430 // find the tool by id
431 wxToolBarToolBase *FindById(int toolid) const;
432
433 // return TRUE if this is a vertical toolbar, otherwise FALSE
434 bool IsVertical() const { return HasFlag(wxTB_VERTICAL); }
435
436
437 // the old versions of the various methods kept for compatibility
438 // don't use in the new code!
439 // --------------------------------------------------------------
440
441 wxToolBarToolBase *AddTool(int toolid,
442 const wxBitmap& bitmap,
443 const wxBitmap& bmpDisabled,
444 bool toggle = FALSE,
445 wxObject *clientData = NULL,
446 const wxString& shortHelpString = wxEmptyString,
447 const wxString& longHelpString = wxEmptyString)
448 {
449 return AddTool(toolid, wxEmptyString,
450 bitmap, bmpDisabled,
451 toggle ? wxITEM_CHECK : wxITEM_NORMAL,
452 shortHelpString, longHelpString, clientData);
453 }
454
455 wxToolBarToolBase *AddTool(int toolid,
456 const wxBitmap& bitmap,
457 const wxString& shortHelpString = wxEmptyString,
458 const wxString& longHelpString = wxEmptyString)
459 {
460 return AddTool(toolid, wxEmptyString,
461 bitmap, wxNullBitmap, wxITEM_NORMAL,
462 shortHelpString, longHelpString, NULL);
463 }
464
465 wxToolBarToolBase *AddTool(int toolid,
466 const wxBitmap& bitmap,
467 const wxBitmap& bmpDisabled,
468 bool toggle,
469 wxCoord xPos,
470 wxCoord yPos = -1,
471 wxObject *clientData = NULL,
472 const wxString& shortHelp = wxEmptyString,
473 const wxString& longHelp = wxEmptyString)
474 {
475 return DoAddTool(toolid, wxEmptyString, bitmap, bmpDisabled,
476 toggle ? wxITEM_CHECK : wxITEM_NORMAL,
477 shortHelp, longHelp, clientData, xPos, yPos);
478 }
479
480 wxToolBarToolBase *InsertTool(size_t pos,
481 int toolid,
482 const wxBitmap& bitmap,
483 const wxBitmap& bmpDisabled = wxNullBitmap,
484 bool toggle = FALSE,
485 wxObject *clientData = NULL,
486 const wxString& shortHelp = wxEmptyString,
487 const wxString& longHelp = wxEmptyString)
488 {
489 return InsertTool(pos, toolid, wxEmptyString, bitmap, bmpDisabled,
490 toggle ? wxITEM_CHECK : wxITEM_NORMAL,
491 shortHelp, longHelp, clientData);
492 }
493
494 // event handlers
495 // --------------
496
497 // NB: these functions are deprecated, use EVT_TOOL_XXX() instead!
498
499 // Only allow toggle if returns TRUE. Call when left button up.
500 virtual bool OnLeftClick(int toolid, bool toggleDown);
501
502 // Call when right button down.
503 virtual void OnRightClick(int toolid, long x, long y);
504
505 // Called when the mouse cursor enters a tool bitmap.
506 // Argument is -1 if mouse is exiting the toolbar.
507 virtual void OnMouseEnter(int toolid);
508
509 // more deprecated functions
510 // -------------------------
511
512 // use GetToolMargins() instead
513 wxSize GetMargins() const { return GetToolMargins(); }
514
515 // implementation only from now on
516 // -------------------------------
517
518 size_t GetToolsCount() const { return m_tools.GetCount(); }
519
520 // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
521 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE) ;
522
523 // don't want toolbars to accept the focus
524 virtual bool AcceptsFocus() const { return FALSE; }
525
526protected:
527 // to implement in derived classes
528 // -------------------------------
529
530 // create a new toolbar tool and add it to the toolbar, this is typically
531 // implemented by just calling InsertTool()
532 virtual wxToolBarToolBase *DoAddTool
533 (
534 int toolid,
535 const wxString& label,
536 const wxBitmap& bitmap,
537 const wxBitmap& bmpDisabled,
538 wxItemKind kind,
539 const wxString& shortHelp = wxEmptyString,
540 const wxString& longHelp = wxEmptyString,
541 wxObject *clientData = NULL,
542 wxCoord xPos = -1,
543 wxCoord yPos = -1
544 );
545
546 // the tool is not yet inserted into m_tools list when this function is
547 // called and will only be added to it if this function succeeds
548 virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool) = 0;
549
550 // the tool is still in m_tools list when this function is called, it will
551 // only be deleted from it if it succeeds
552 virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool) = 0;
553
554 // called when the tools enabled flag changes
555 virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable) = 0;
556
557 // called when the tool is toggled
558 virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle) = 0;
559
560 // called when the tools "can be toggled" flag changes
561 virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle) = 0;
562
563 // the functions to create toolbar tools
564 virtual wxToolBarToolBase *CreateTool(int toolid,
565 const wxString& label,
566 const wxBitmap& bmpNormal,
567 const wxBitmap& bmpDisabled,
568 wxItemKind kind,
569 wxObject *clientData,
570 const wxString& shortHelp,
571 const wxString& longHelp) = 0;
572
573 virtual wxToolBarToolBase *CreateTool(wxControl *control) = 0;
574
575 // helper functions
576 // ----------------
577
578 // un-toggle all buttons in the same radio group
579 void UnToggleRadioGroup(wxToolBarToolBase *tool);
580
581 // the list of all our tools
582 wxToolBarToolsList m_tools;
583
584 // the offset of the first tool
585 int m_xMargin;
586 int m_yMargin;
587
588 // the maximum number of toolbar rows/columns
589 int m_maxRows;
590 int m_maxCols;
591
592 // the tool packing and separation
593 int m_toolPacking,
594 m_toolSeparation;
595
596 // the size of the toolbar bitmaps
597 wxCoord m_defaultWidth, m_defaultHeight;
598
599private:
600 DECLARE_EVENT_TABLE()
601 DECLARE_NO_COPY_CLASS(wxToolBarBase)
602};
603
604// Helper function for creating the image for disabled buttons
605bool wxCreateGreyedImage(const wxImage& in, wxImage& out) ;
606
607#endif // wxUSE_TOOLBAR
608
609#endif
610 // _WX_TBARBASE_H_
611