360 lines
12 KiB
C++
360 lines
12 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/generic/tabg.h
|
|
// Purpose: Generic tabbed dialogs; used by wxMotif's wxNotebook
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id: tabg.h 67254 2011-03-20 00:14:35Z DS $
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef __TABGH_G__
|
|
#define __TABGH_G__
|
|
|
|
#define WXTAB_VERSION 1.1
|
|
|
|
#include "wx/hashmap.h"
|
|
#include "wx/string.h"
|
|
#include "wx/dialog.h"
|
|
#include "wx/panel.h"
|
|
#include "wx/list.h"
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxTabView;
|
|
|
|
/*
|
|
* A wxTabControl is the internal and visual representation
|
|
* of the tab.
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxTabControl: public wxObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxTabControl)
|
|
public:
|
|
wxTabControl(wxTabView *v = NULL);
|
|
virtual ~wxTabControl(void);
|
|
|
|
virtual void OnDraw(wxDC& dc, bool lastInRow);
|
|
void SetLabel(const wxString& str) { m_controlLabel = str; }
|
|
wxString GetLabel(void) const { return m_controlLabel; }
|
|
|
|
void SetFont(const wxFont& f) { m_labelFont = f; }
|
|
wxFont *GetFont(void) const { return (wxFont*) & m_labelFont; }
|
|
|
|
void SetSelected(bool sel) { m_isSelected = sel; }
|
|
bool IsSelected(void) const { return m_isSelected; }
|
|
|
|
void SetPosition(int x, int y) { m_offsetX = x; m_offsetY = y; }
|
|
void SetSize(int x, int y) { m_width = x; m_height = y; }
|
|
|
|
void SetRowPosition(int r) { m_rowPosition = r; }
|
|
int GetRowPosition() const { return m_rowPosition; }
|
|
void SetColPosition(int c) { m_colPosition = c; }
|
|
int GetColPosition() const { return m_colPosition; }
|
|
|
|
int GetX(void) const { return m_offsetX; }
|
|
int GetY(void) const { return m_offsetY; }
|
|
int GetWidth(void) const { return m_width; }
|
|
int GetHeight(void) const { return m_height; }
|
|
|
|
int GetId(void) const { return m_id; }
|
|
void SetId(int i) { m_id = i; }
|
|
|
|
virtual bool HitTest(int x, int y) const ;
|
|
|
|
protected:
|
|
wxTabView* m_view;
|
|
wxString m_controlLabel;
|
|
bool m_isSelected;
|
|
wxFont m_labelFont;
|
|
int m_offsetX; // Offsets from top-left of tab view area (the area below the tabs)
|
|
int m_offsetY;
|
|
int m_width;
|
|
int m_height;
|
|
int m_id;
|
|
int m_rowPosition; // Position in row from 0
|
|
int m_colPosition; // Position in col from 0
|
|
};
|
|
|
|
/*
|
|
* Each wxTabLayer is a list of tabs. E.g. there
|
|
* are 3 layers in the MS Word Options dialog.
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxTabLayer: public wxList
|
|
{
|
|
};
|
|
|
|
/*
|
|
* The wxTabView controls and draws the tabbed object
|
|
*/
|
|
|
|
WX_DECLARE_LIST(wxTabLayer, wxTabLayerList);
|
|
|
|
#define wxTAB_STYLE_DRAW_BOX 1 // Draws 3D boxes round tab layers
|
|
#define wxTAB_STYLE_COLOUR_INTERIOR 2 // Colours interior of tabs, otherwise draws outline
|
|
|
|
class WXDLLIMPEXP_CORE wxTabView: public wxObject
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxTabView)
|
|
public:
|
|
wxTabView(long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
|
|
virtual ~wxTabView();
|
|
|
|
inline int GetNumberOfLayers() const { return m_layers.GetCount(); }
|
|
inline wxTabLayerList& GetLayers() { return m_layers; }
|
|
|
|
inline void SetWindow(wxWindow* wnd) { m_window = wnd; }
|
|
inline wxWindow* GetWindow(void) const { return m_window; }
|
|
|
|
// Automatically positions tabs
|
|
wxTabControl *AddTab(int id, const wxString& label, wxTabControl *existingTab = NULL);
|
|
|
|
// Remove the tab without deleting the window
|
|
bool RemoveTab(int id);
|
|
|
|
void ClearTabs(bool deleteTabs = true);
|
|
|
|
bool SetTabText(int id, const wxString& label);
|
|
wxString GetTabText(int id) const;
|
|
|
|
// Layout tabs (optional, e.g. if resizing window)
|
|
void LayoutTabs();
|
|
|
|
// Draw all tabs
|
|
virtual void Draw(wxDC& dc);
|
|
|
|
// Process mouse event, return false if we didn't process it
|
|
virtual bool OnEvent(wxMouseEvent& event);
|
|
|
|
// Called when a tab is activated
|
|
virtual void OnTabActivate(int activateId, int deactivateId);
|
|
// Allows vetoing
|
|
virtual bool OnTabPreActivate(int WXUNUSED(activateId), int WXUNUSED(deactivateId) ) { return true; };
|
|
|
|
// Allows use of application-supplied wxTabControl classes.
|
|
virtual wxTabControl *OnCreateTabControl(void) { return new wxTabControl(this); }
|
|
|
|
void SetHighlightColour(const wxColour& col);
|
|
void SetShadowColour(const wxColour& col);
|
|
void SetBackgroundColour(const wxColour& col);
|
|
inline void SetTextColour(const wxColour& col) { m_textColour = col; }
|
|
|
|
inline wxColour GetHighlightColour(void) const { return m_highlightColour; }
|
|
inline wxColour GetShadowColour(void) const { return m_shadowColour; }
|
|
inline wxColour GetBackgroundColour(void) const { return m_backgroundColour; }
|
|
inline wxColour GetTextColour(void) const { return m_textColour; }
|
|
inline const wxPen *GetHighlightPen(void) const { return m_highlightPen; }
|
|
inline const wxPen *GetShadowPen(void) const { return m_shadowPen; }
|
|
inline const wxPen *GetBackgroundPen(void) const { return m_backgroundPen; }
|
|
inline const wxBrush *GetBackgroundBrush(void) const { return m_backgroundBrush; }
|
|
|
|
inline void SetViewRect(const wxRect& rect) { m_tabViewRect = rect; }
|
|
inline wxRect GetViewRect(void) const { return m_tabViewRect; }
|
|
|
|
// Calculate tab width to fit to view, and optionally adjust the view
|
|
// to fit the tabs exactly.
|
|
int CalculateTabWidth(int noTabs, bool adjustView = false);
|
|
|
|
inline void SetTabStyle(long style) { m_tabStyle = style; }
|
|
inline long GetTabStyle(void) const { return m_tabStyle; }
|
|
|
|
inline void SetTabSize(int w, int h) { m_tabWidth = w; m_tabHeight = h; }
|
|
inline int GetTabWidth(void) const { return m_tabWidth; }
|
|
inline int GetTabHeight(void) const { return m_tabHeight; }
|
|
inline void SetTabSelectionHeight(int h) { m_tabSelectionHeight = h; }
|
|
inline int GetTabSelectionHeight(void) const { return m_tabSelectionHeight; }
|
|
|
|
// Returns the total height of the tabs component -- this may be several
|
|
// times the height of a tab, if there are several tab layers (rows).
|
|
int GetTotalTabHeight();
|
|
|
|
inline int GetTopMargin(void) const { return m_topMargin; }
|
|
inline void SetTopMargin(int margin) { m_topMargin = margin; }
|
|
|
|
void SetTabSelection(int sel, bool activateTool = true);
|
|
inline int GetTabSelection() const { return m_tabSelection; }
|
|
|
|
// Find tab control for id
|
|
wxTabControl *FindTabControlForId(int id) const ;
|
|
|
|
// Find tab control for layer, position (starting from zero)
|
|
wxTabControl *FindTabControlForPosition(int layer, int position) const ;
|
|
|
|
inline int GetHorizontalTabOffset() const { return m_tabHorizontalOffset; }
|
|
inline int GetHorizontalTabSpacing() const { return m_tabHorizontalSpacing; }
|
|
inline void SetHorizontalTabOffset(int sp) { m_tabHorizontalOffset = sp; }
|
|
inline void SetHorizontalTabSpacing(int sp) { m_tabHorizontalSpacing = sp; }
|
|
|
|
inline void SetVerticalTabTextSpacing(int s) { m_tabVerticalTextSpacing = s; }
|
|
inline int GetVerticalTabTextSpacing() const { return m_tabVerticalTextSpacing; }
|
|
|
|
inline wxFont *GetTabFont() const { return (wxFont*) & m_tabFont; }
|
|
inline void SetTabFont(const wxFont& f) { m_tabFont = f; }
|
|
|
|
inline wxFont *GetSelectedTabFont() const { return (wxFont*) & m_tabSelectedFont; }
|
|
inline void SetSelectedTabFont(const wxFont& f) { m_tabSelectedFont = f; }
|
|
// Find the node and the column at which this control is positioned.
|
|
wxList::compatibility_iterator FindTabNodeAndColumn(wxTabControl *control, int *col) const ;
|
|
|
|
// Do the necessary to change to this tab
|
|
virtual bool ChangeTab(wxTabControl *control);
|
|
|
|
// Move the selected tab to the bottom layer, if necessary,
|
|
// without calling app activation code
|
|
bool MoveSelectionTab(wxTabControl *control);
|
|
|
|
inline int GetNumberOfTabs() const { return m_noTabs; }
|
|
|
|
protected:
|
|
// List of layers, from front to back.
|
|
wxTabLayerList m_layers;
|
|
|
|
// Selected tab
|
|
int m_tabSelection;
|
|
|
|
// Usual tab height
|
|
int m_tabHeight;
|
|
|
|
// The height of the selected tab
|
|
int m_tabSelectionHeight;
|
|
|
|
// Usual tab width
|
|
int m_tabWidth;
|
|
|
|
// Space between tabs
|
|
int m_tabHorizontalSpacing;
|
|
|
|
// Space between top of normal tab and text
|
|
int m_tabVerticalTextSpacing;
|
|
|
|
// Horizontal offset of each tab row above the first
|
|
int m_tabHorizontalOffset;
|
|
|
|
// The distance between the bottom of the first tab row
|
|
// and the top of the client area (i.e. the margin)
|
|
int m_topMargin;
|
|
|
|
// The position and size of the view above which the tabs are placed.
|
|
// I.e., the internal client area of the sheet.
|
|
wxRect m_tabViewRect;
|
|
|
|
// Bitlist of styles
|
|
long m_tabStyle;
|
|
|
|
// Colours
|
|
wxColour m_highlightColour;
|
|
wxColour m_shadowColour;
|
|
wxColour m_backgroundColour;
|
|
wxColour m_textColour;
|
|
|
|
// Pen and brush cache
|
|
const wxPen* m_highlightPen;
|
|
const wxPen* m_shadowPen;
|
|
const wxPen* m_backgroundPen;
|
|
const wxBrush* m_backgroundBrush;
|
|
|
|
wxFont m_tabFont;
|
|
wxFont m_tabSelectedFont;
|
|
|
|
int m_noTabs;
|
|
|
|
wxWindow* m_window;
|
|
};
|
|
|
|
/*
|
|
* A dialog box class that is tab-friendly
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxTabbedDialog : public wxDialog
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxTabbedDialog)
|
|
|
|
public:
|
|
wxTabbedDialog(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxString& title,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long windowStyle = wxDEFAULT_DIALOG_STYLE,
|
|
const wxString& name = wxDialogNameStr);
|
|
virtual ~wxTabbedDialog();
|
|
|
|
wxTabView *GetTabView() const { return m_tabView; }
|
|
void SetTabView(wxTabView *v) { m_tabView = v; }
|
|
|
|
void OnCloseWindow(wxCloseEvent& event);
|
|
void OnMouseEvent(wxMouseEvent& event);
|
|
void OnPaint(wxPaintEvent& event);
|
|
|
|
protected:
|
|
wxTabView* m_tabView;
|
|
|
|
private:
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
/*
|
|
* A panel class that is tab-friendly
|
|
*/
|
|
|
|
class WXDLLIMPEXP_CORE wxTabbedPanel : public wxPanel
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxTabbedPanel)
|
|
|
|
public:
|
|
wxTabbedPanel(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long windowStyle = 0,
|
|
const wxString& name = wxPanelNameStr);
|
|
virtual ~wxTabbedPanel();
|
|
|
|
wxTabView *GetTabView() const { return m_tabView; }
|
|
void SetTabView(wxTabView *v) { m_tabView = v; }
|
|
|
|
void OnMouseEvent(wxMouseEvent& event);
|
|
void OnPaint(wxPaintEvent& event);
|
|
|
|
protected:
|
|
wxTabView* m_tabView;
|
|
|
|
private:
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
WX_DECLARE_HASH_MAP(int, wxWindow*, wxIntegerHash, wxIntegerEqual,
|
|
wxIntToWindowHashMap);
|
|
|
|
class WXDLLIMPEXP_CORE wxPanelTabView : public wxTabView
|
|
{
|
|
DECLARE_DYNAMIC_CLASS(wxPanelTabView)
|
|
|
|
public:
|
|
wxPanelTabView(wxPanel *pan, long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
|
|
virtual ~wxPanelTabView(void);
|
|
|
|
// Called when a tab is activated
|
|
virtual void OnTabActivate(int activateId, int deactivateId);
|
|
|
|
// Specific to this class
|
|
void AddTabWindow(int id, wxWindow *window);
|
|
wxWindow *GetTabWindow(int id) const ;
|
|
void ClearWindows(bool deleteWindows = true);
|
|
wxWindow *GetCurrentWindow() const { return m_currentWindow; }
|
|
|
|
void ShowWindowForTab(int id);
|
|
// wxList& GetWindows() const { return (wxList&) m_tabWindows; }
|
|
|
|
protected:
|
|
// List of panels, one for each tab. Indexed
|
|
// by tab ID.
|
|
wxIntToWindowHashMap m_tabWindows;
|
|
wxWindow* m_currentWindow;
|
|
wxPanel* m_panel;
|
|
};
|
|
|
|
#endif
|
|
|