include/wx/gtk/tbargtk.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tbargtk.h
   3 // Purpose:     GTK toolbar
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef __TBARGTKH__
  11 #define __TBARGTKH__
  12
  13 #ifdef __GNUG__
  14 #pragma interface
  15 #endif
  16
  17 #include "wx/defs.h"
  18
  19 #if wxUSE_TOOLBAR
  20
  21 #include "wx/control.h"
  22 #include "wx/bitmap.h"
  23 #include "wx/tbarbase.h"
  24
  25 //-----------------------------------------------------------------------------
  26 // classes
  27 //-----------------------------------------------------------------------------
  28
  29 class wxToolBarTool;
  30 class wxToolBar;
  31
  32 //-----------------------------------------------------------------------------
  33 // constants
  34 //-----------------------------------------------------------------------------
  35
  36 #define wxTOOL_STYLE_BUTTON          1
  37 #define wxTOOL_STYLE_SEPARATOR       2
  38
  39 //-----------------------------------------------------------------------------
  40 // global data
  41 //-----------------------------------------------------------------------------
  42
  43 extern const wxChar *wxToolBarNameStr;
  44
  45 //-----------------------------------------------------------------------------
  46 // wxToolBar
  47 //-----------------------------------------------------------------------------
  48
  49 class wxToolBar: public wxControl
  50 {
  51   DECLARE_EVENT_TABLE()
  52   DECLARE_DYNAMIC_CLASS(wxToolBar)
  53
  54   public:
  55
  56     wxToolBar(void);
  57     wxToolBar( wxWindow *parent, wxWindowID id,
  58       const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
  59       long style = 0, const wxString& name = wxToolBarNameStr );
  60    ~wxToolBar(void);
  61
  62    bool Create( wxWindow *parent, wxWindowID id,
  63      const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
  64      long style = 0, const wxString& name = wxToolBarNameStr);
  65
  66     // Only allow toggle if returns TRUE. Call when left button up.
  67     virtual bool OnLeftClick(int toolIndex, bool toggleDown);
  68
  69     // Call when right button down.
  70     virtual void OnRightClick(int toolIndex, float x, float y);
  71
  72     // Called when the mouse cursor enters a tool bitmap.
  73     // Argument is -1 if mouse is exiting the toolbar.
  74     virtual void OnMouseEnter(int toolIndex);
  75
  76     // If pushedBitmap is NULL, a reversed version of bitmap is
  77     // created and used as the pushed/toggled image.
  78     // If toggle is TRUE, the button toggles between the two states.
  79     virtual wxToolBarTool *AddTool( int toolIndex, const wxBitmap& bitmap,
  80       const wxBitmap& pushedBitmap = wxNullBitmap, bool toggle = FALSE,
  81       float xPos = -1, float yPos = -1, wxObject *clientData = (wxObject *)NULL,
  82       const wxString& helpString1 = "", const wxString& helpString2 = "");
  83     virtual void AddSeparator(void);
  84     virtual void ClearTools(void);
  85
  86     virtual bool Realize(void);
  87
  88     virtual void EnableTool(int toolIndex, bool enable);
  89     virtual void ToggleTool(int toolIndex, bool toggle); // toggle is TRUE if toggled on
  90     virtual wxObject *GetToolClientData(int index) const;
  91
  92     virtual bool GetToolState(int toolIndex) const;
  93     virtual bool GetToolEnabled(int toolIndex) const;
  94
  95     virtual void SetMargins(int x, int y);
  96     void SetMargins(const wxSize& size) { SetMargins(size.x, size.y); };
  97     virtual wxSize GetToolMargins(void) { return wxSize(m_xMargin, m_yMargin); }
  98
  99     virtual void SetToolPacking(int packing);
 100     virtual void SetToolSeparation(int separation);
 101     virtual int GetToolPacking();
 102     virtual int GetToolSeparation();
 103
 104     virtual wxString GetToolLongHelp(int toolIndex);
 105     virtual wxString GetToolShortHelp(int toolIndex);
 106
 107     virtual void SetToolLongHelp(int toolIndex, const wxString& helpString);
 108     virtual void SetToolShortHelp(int toolIndex, const wxString& helpString);
 109
 110     void OnIdle( wxIdleEvent &ievent );
 111
 112   // implementation
 113
 114     GtkToolbar   *m_toolbar;
 115     int           m_separation;
 116     wxList        m_tools;
 117
 118     GdkColor      *m_fg;
 119     GdkColor      *m_bg;
 120     int           m_xMargin;
 121     int           m_yMargin;
 122     bool          m_hasToolAlready;
 123 };
 124
 125 #endif
 126
 127 #endif
 128     // __TBARGTKH__