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