include/wx/generic/tabg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tabg.h
   3 // Purpose:     Generic tabbed dialogs
   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 __TABGH_G__
  13 #define __TABGH_G__
  14
  15 #define WXTAB_VERSION   1.1
  16
  17 #include "wx/hashmap.h"
  18 #include "wx/string.h"
  19 #include "wx/dialog.h"
  20 #include "wx/panel.h"
  21 #include "wx/list.h"
  22
  23 class WXDLLIMPEXP_FWD_CORE wxTabView;
  24
  25 /*
  26  * A wxTabControl is the internal and visual representation
  27  * of the tab.
  28  */
  29
  30 class WXDLLEXPORT wxTabControl: public wxObject
  31 {
  32 DECLARE_DYNAMIC_CLASS(wxTabControl)
  33 public:
  34     wxTabControl(wxTabView *v = (wxTabView *) NULL);
  35     virtual ~wxTabControl(void);
  36
  37     virtual void OnDraw(wxDC& dc, bool lastInRow);
  38     void SetLabel(const wxString& str) { m_controlLabel = str; }
  39     wxString GetLabel(void) const { return m_controlLabel; }
  40
  41     void SetFont(const wxFont& f) { m_labelFont = f; }
  42     wxFont *GetFont(void) const { return (wxFont*) & m_labelFont; }
  43
  44     void SetSelected(bool sel) { m_isSelected = sel; }
  45     bool IsSelected(void) const { return m_isSelected; }
  46
  47     void SetPosition(int x, int y) { m_offsetX = x; m_offsetY = y; }
  48     void SetSize(int x, int y) { m_width = x; m_height = y; }
  49
  50     void SetRowPosition(int r) { m_rowPosition = r; }
  51     int GetRowPosition() const { return m_rowPosition; }
  52     void SetColPosition(int c) { m_colPosition = c; }
  53     int GetColPosition() const { return m_colPosition; }
  54
  55     int GetX(void) const { return m_offsetX; }
  56     int GetY(void) const { return m_offsetY; }
  57     int GetWidth(void) const { return m_width; }
  58     int GetHeight(void) const { return m_height; }
  59
  60     int GetId(void) const { return m_id; }
  61     void SetId(int i) { m_id = i; }
  62
  63     virtual bool HitTest(int x, int y) const ;
  64
  65 protected:
  66     wxTabView*      m_view;
  67     wxString        m_controlLabel;
  68     bool            m_isSelected;
  69     wxFont          m_labelFont;
  70     int             m_offsetX; // Offsets from top-left of tab view area (the area below the tabs)
  71     int             m_offsetY;
  72     int             m_width;
  73     int             m_height;
  74     int             m_id;
  75     int             m_rowPosition; // Position in row from 0
  76     int             m_colPosition; // Position in col from 0
  77 };
  78
  79 /*
  80  * Each wxTabLayer is a list of tabs. E.g. there
  81  * are 3 layers in the MS Word Options dialog.
  82  */
  83
  84 class WXDLLEXPORT wxTabLayer: public wxList
  85 {
  86 };
  87
  88 /*
  89  * The wxTabView controls and draws the tabbed object
  90  */
  91
  92 WX_DECLARE_LIST(wxTabLayer, wxTabLayerList);
  93
  94 #define wxTAB_STYLE_DRAW_BOX         1   // Draws 3D boxes round tab layers
  95 #define wxTAB_STYLE_COLOUR_INTERIOR  2   // Colours interior of tabs, otherwise draws outline
  96
  97 class WXDLLEXPORT wxTabView: public wxObject
  98 {
  99 DECLARE_DYNAMIC_CLASS(wxTabView)
 100 public:
 101   wxTabView(long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
 102   virtual ~wxTabView();
 103
 104   inline int GetNumberOfLayers() const { return m_layers.GetCount(); }
 105   inline wxTabLayerList& GetLayers() { return m_layers; }
 106
 107   inline void SetWindow(wxWindow* wnd) { m_window = wnd; }
 108   inline wxWindow* GetWindow(void) const { return m_window; }
 109
 110   // Automatically positions tabs
 111   wxTabControl *AddTab(int id, const wxString& label, wxTabControl *existingTab = (wxTabControl *) NULL);
 112
 113   // Remove the tab without deleting the window
 114   bool RemoveTab(int id);
 115
 116   void ClearTabs(bool deleteTabs = true);
 117
 118   bool SetTabText(int id, const wxString& label);
 119   wxString GetTabText(int id) const;
 120
 121   // Layout tabs (optional, e.g. if resizing window)
 122   void LayoutTabs();
 123
 124   // Draw all tabs
 125   virtual void Draw(wxDC& dc);
 126
 127   // Process mouse event, return false if we didn't process it
 128   virtual bool OnEvent(wxMouseEvent& event);
 129
 130   // Called when a tab is activated
 131   virtual void OnTabActivate(int activateId, int deactivateId);
 132   // Allows vetoing
 133   virtual bool OnTabPreActivate(int WXUNUSED(activateId), int WXUNUSED(deactivateId) ) { return true; };
 134
 135   // Allows use of application-supplied wxTabControl classes.
 136   virtual wxTabControl *OnCreateTabControl(void) { return new wxTabControl(this); }
 137
 138   void SetHighlightColour(const wxColour& col);
 139   void SetShadowColour(const wxColour& col);
 140   void SetBackgroundColour(const wxColour& col);
 141   inline void SetTextColour(const wxColour& col) { m_textColour = col; }
 142
 143   inline wxColour GetHighlightColour(void) const { return m_highlightColour; }
 144   inline wxColour GetShadowColour(void) const { return m_shadowColour; }
 145   inline wxColour GetBackgroundColour(void) const { return m_backgroundColour; }
 146   inline wxColour GetTextColour(void) const { return m_textColour; }
 147   inline const wxPen *GetHighlightPen(void) const { return m_highlightPen; }
 148   inline const wxPen *GetShadowPen(void) const { return m_shadowPen; }
 149   inline const wxPen *GetBackgroundPen(void) const { return m_backgroundPen; }
 150   inline const wxBrush *GetBackgroundBrush(void) const { return m_backgroundBrush; }
 151
 152   inline void SetViewRect(const wxRect& rect) { m_tabViewRect = rect; }
 153   inline wxRect GetViewRect(void) const { return m_tabViewRect; }
 154
 155   // Calculate tab width to fit to view, and optionally adjust the view
 156   // to fit the tabs exactly.
 157   int CalculateTabWidth(int noTabs, bool adjustView = false);
 158
 159   inline void SetTabStyle(long style) { m_tabStyle = style; }
 160   inline long GetTabStyle(void) const { return m_tabStyle; }
 161
 162   inline void SetTabSize(int w, int h) { m_tabWidth = w; m_tabHeight = h; }
 163   inline int GetTabWidth(void) const { return m_tabWidth; }
 164   inline int GetTabHeight(void) const { return m_tabHeight; }
 165   inline void SetTabSelectionHeight(int h) { m_tabSelectionHeight = h; }
 166   inline int GetTabSelectionHeight(void) const { return m_tabSelectionHeight; }
 167
 168   // Returns the total height of the tabs component -- this may be several
 169   // times the height of a tab, if there are several tab layers (rows).
 170   int GetTotalTabHeight();
 171
 172   inline int GetTopMargin(void) const { return m_topMargin; }
 173   inline void SetTopMargin(int margin) { m_topMargin = margin; }
 174
 175   void SetTabSelection(int sel, bool activateTool = true);
 176   inline int GetTabSelection() const { return m_tabSelection; }
 177
 178   // Find tab control for id
 179   wxTabControl *FindTabControlForId(int id) const ;
 180
 181   // Find tab control for layer, position (starting from zero)
 182   wxTabControl *FindTabControlForPosition(int layer, int position) const ;
 183
 184   inline int GetHorizontalTabOffset() const { return m_tabHorizontalOffset; }
 185   inline int GetHorizontalTabSpacing() const { return m_tabHorizontalSpacing; }
 186   inline void SetHorizontalTabOffset(int sp) { m_tabHorizontalOffset = sp; }
 187   inline void SetHorizontalTabSpacing(int sp) { m_tabHorizontalSpacing = sp; }
 188
 189   inline void SetVerticalTabTextSpacing(int s) { m_tabVerticalTextSpacing = s; }
 190   inline int GetVerticalTabTextSpacing() const { return m_tabVerticalTextSpacing; }
 191
 192   inline wxFont *GetTabFont() const { return (wxFont*) & m_tabFont; }
 193   inline void SetTabFont(const wxFont& f) { m_tabFont = f; }
 194
 195   inline wxFont *GetSelectedTabFont() const { return (wxFont*) & m_tabSelectedFont; }
 196   inline void SetSelectedTabFont(const wxFont& f) { m_tabSelectedFont = f; }
 197   // Find the node and the column at which this control is positioned.
 198   wxList::compatibility_iterator FindTabNodeAndColumn(wxTabControl *control, int *col) const ;
 199
 200   // Do the necessary to change to this tab
 201   virtual bool ChangeTab(wxTabControl *control);
 202
 203   // Move the selected tab to the bottom layer, if necessary,
 204   // without calling app activation code
 205   bool MoveSelectionTab(wxTabControl *control);
 206
 207   inline int GetNumberOfTabs() const { return m_noTabs; }
 208
 209 protected:
 210    // List of layers, from front to back.
 211    wxTabLayerList   m_layers;
 212
 213    // Selected tab
 214    int              m_tabSelection;
 215
 216    // Usual tab height
 217    int              m_tabHeight;
 218
 219    // The height of the selected tab
 220    int              m_tabSelectionHeight;
 221
 222    // Usual tab width
 223    int              m_tabWidth;
 224
 225    // Space between tabs
 226    int              m_tabHorizontalSpacing;
 227
 228    // Space between top of normal tab and text
 229    int              m_tabVerticalTextSpacing;
 230
 231    // Horizontal offset of each tab row above the first
 232    int              m_tabHorizontalOffset;
 233
 234    // The distance between the bottom of the first tab row
 235    // and the top of the client area (i.e. the margin)
 236    int              m_topMargin;
 237
 238    // The position and size of the view above which the tabs are placed.
 239    // I.e., the internal client area of the sheet.
 240    wxRect           m_tabViewRect;
 241
 242    // Bitlist of styles
 243    long             m_tabStyle;
 244
 245    // Colours
 246    wxColour         m_highlightColour;
 247    wxColour         m_shadowColour;
 248    wxColour         m_backgroundColour;
 249    wxColour         m_textColour;
 250
 251    // Pen and brush cache
 252    const wxPen*     m_highlightPen;
 253    const wxPen*     m_shadowPen;
 254    const wxPen*     m_backgroundPen;
 255    const wxBrush*   m_backgroundBrush;
 256
 257    wxFont           m_tabFont;
 258    wxFont           m_tabSelectedFont;
 259
 260    int              m_noTabs;
 261
 262    wxWindow*        m_window;
 263 };
 264
 265 /*
 266  * A dialog box class that is tab-friendly
 267  */
 268
 269 class WXDLLEXPORT wxTabbedDialog : public wxDialog
 270 {
 271     DECLARE_DYNAMIC_CLASS(wxTabbedDialog)
 272
 273 public:
 274     wxTabbedDialog(wxWindow *parent,
 275                    wxWindowID id,
 276                    const wxString& title,
 277                    const wxPoint& pos = wxDefaultPosition,
 278                    const wxSize& size = wxDefaultSize,
 279                    long windowStyle = wxDEFAULT_DIALOG_STYLE,
 280                    const wxString& name = wxDialogNameStr);
 281     virtual ~wxTabbedDialog();
 282
 283     wxTabView *GetTabView() const { return m_tabView; }
 284     void SetTabView(wxTabView *v) { m_tabView = v; }
 285
 286     void OnCloseWindow(wxCloseEvent& event);
 287     void OnMouseEvent(wxMouseEvent& event);
 288     void OnPaint(wxPaintEvent& event);
 289
 290 protected:
 291     wxTabView*   m_tabView;
 292
 293 private:
 294     DECLARE_EVENT_TABLE()
 295 };
 296
 297 /*
 298  * A panel class that is tab-friendly
 299  */
 300
 301 class WXDLLEXPORT wxTabbedPanel : public wxPanel
 302 {
 303     DECLARE_DYNAMIC_CLASS(wxTabbedPanel)
 304
 305 public:
 306     wxTabbedPanel(wxWindow *parent,
 307                   wxWindowID id,
 308                   const wxPoint& pos = wxDefaultPosition,
 309                   const wxSize& size = wxDefaultSize,
 310                   long windowStyle = 0,
 311                   const wxString& name = wxPanelNameStr);
 312     virtual ~wxTabbedPanel();
 313
 314     wxTabView *GetTabView() const { return m_tabView; }
 315     void SetTabView(wxTabView *v) { m_tabView = v; }
 316
 317     void OnMouseEvent(wxMouseEvent& event);
 318     void OnPaint(wxPaintEvent& event);
 319
 320 protected:
 321     wxTabView*   m_tabView;
 322
 323 private:
 324     DECLARE_EVENT_TABLE()
 325 };
 326
 327 WX_DECLARE_HASH_MAP(int, wxWindow*, wxIntegerHash, wxIntegerEqual,
 328                     wxIntToWindowHashMap);
 329
 330 class WXDLLEXPORT wxPanelTabView : public wxTabView
 331 {
 332     DECLARE_DYNAMIC_CLASS(wxPanelTabView)
 333
 334 public:
 335     wxPanelTabView(wxPanel *pan, long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
 336     virtual ~wxPanelTabView(void);
 337
 338     // Called when a tab is activated
 339     virtual void OnTabActivate(int activateId, int deactivateId);
 340
 341     // Specific to this class
 342     void AddTabWindow(int id, wxWindow *window);
 343     wxWindow *GetTabWindow(int id) const ;
 344     void ClearWindows(bool deleteWindows = true);
 345     wxWindow *GetCurrentWindow() const { return m_currentWindow; }
 346
 347     void ShowWindowForTab(int id);
 348     // wxList& GetWindows() const { return (wxList&) m_tabWindows; }
 349
 350 protected:
 351     // List of panels, one for each tab. Indexed
 352     // by tab ID.
 353     wxIntToWindowHashMap m_tabWindows;
 354     wxWindow*            m_currentWindow;
 355     wxPanel*             m_panel;
 356 };
 357
 358 #endif
 359