]> git.saurik.com Git - wxWidgets.git/blame - include/wx/notebook.h
fixed wxImage->wxBitmap conversion for images with alpha channel
[wxWidgets.git] / include / wx / notebook.h
CommitLineData
1e6feb95
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/notebook.h
3// Purpose: wxNotebook interface
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 01.02.01
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) 1996-2000 wxWidgets team
65571936 9// Licence: wxWindows licence
1e6feb95
VZ
10///////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_NOTEBOOK_H_BASE_
13#define _WX_NOTEBOOK_H_BASE_
53b28675 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
07b8d7ec
VZ
16 #pragma interface "notebookbase.h"
17#endif
18
4d0f3cd6
VZ
19// ----------------------------------------------------------------------------
20// headers
21// ----------------------------------------------------------------------------
22
1e6feb95
VZ
23#include "wx/defs.h"
24
25#if wxUSE_NOTEBOOK
26
15aad3b9 27#include "wx/bookctrl.h"
1e6feb95 28
e450aa69
VZ
29// ----------------------------------------------------------------------------
30// constants
31// ----------------------------------------------------------------------------
32
33// wxNotebook hit results
34enum
35{
36 wxNB_HITTEST_NOWHERE = 1, // not on tab
37 wxNB_HITTEST_ONICON = 2, // on icon
38 wxNB_HITTEST_ONLABEL = 4, // on label
39 wxNB_HITTEST_ONITEM = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL
40};
41
1e6feb95
VZ
42typedef wxWindow wxNotebookPage; // so far, any window can be a page
43
1e6feb95
VZ
44#define wxNOTEBOOK_NAME _T("notebook")
45
46// ----------------------------------------------------------------------------
47// wxNotebookBase: define wxNotebook interface
48// ----------------------------------------------------------------------------
49
15aad3b9 50class WXDLLEXPORT wxNotebookBase : public wxBookCtrl
1e6feb95
VZ
51{
52public:
15aad3b9
VZ
53 // ctors
54 // -----
55
6463b9f5 56 wxNotebookBase() { }
15aad3b9
VZ
57
58 wxNotebookBase(wxWindow *parent,
aa6f64c7 59 wxWindowID winid,
15aad3b9
VZ
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = 0,
1169a919 63 const wxString& name = wxNOTEBOOK_NAME) ;
1e6feb95 64
15aad3b9
VZ
65 // wxNotebook-specific additions to wxBookCtrl interface
66 // -----------------------------------------------------
1e6feb95
VZ
67
68 // get the number of rows for a control with wxNB_MULTILINE style (not all
69 // versions support it - they will always return 1 then)
70 virtual int GetRowCount() const { return 1; }
71
1e6feb95
VZ
72 // set the padding between tabs (in pixels)
73 virtual void SetPadding(const wxSize& padding) = 0;
74
75 // set the size of the tabs for wxNB_FIXEDWIDTH controls
76 virtual void SetTabSize(const wxSize& sz) = 0;
77
e450aa69
VZ
78 // hit test, returns which tab is hit and, optionally, where (icon, label)
79 // (not implemented on all platforms)
fc7a2a60
VZ
80 virtual int HitTest(const wxPoint& WXUNUSED(pt),
81 long * WXUNUSED(flags) = NULL) const
e450aa69
VZ
82 {
83 return wxNOT_FOUND;
84 }
85
1e6feb95 86
15aad3b9
VZ
87 // implement some base class functions
88 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
22f3361e 89
15aad3b9 90protected:
22f3361e 91 DECLARE_NO_COPY_CLASS(wxNotebookBase)
1e6feb95 92};
4d0f3cd6
VZ
93
94// ----------------------------------------------------------------------------
15aad3b9 95// notebook event class and related stuff
4d0f3cd6
VZ
96// ----------------------------------------------------------------------------
97
15aad3b9 98class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlEvent
4d0f3cd6
VZ
99{
100public:
aa6f64c7 101 wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
4d0f3cd6 102 int nSel = -1, int nOldSel = -1)
aa6f64c7 103 : wxBookCtrlEvent(commandType, winid, nSel, nOldSel)
15aad3b9
VZ
104 {
105 }
4d0f3cd6
VZ
106
107private:
fc7a2a60 108 DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent)
4d0f3cd6
VZ
109};
110
2e4df4bf
VZ
111BEGIN_DECLARE_EVENT_TYPES()
112 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
113 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
114END_DECLARE_EVENT_TYPES()
115
4d0f3cd6
VZ
116typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
117
aa6f64c7 118#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
2e4df4bf 119 DECLARE_EVENT_TABLE_ENTRY( \
4d0f3cd6 120 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \
aa6f64c7 121 winid, \
4d0f3cd6 122 -1, \
3a818b15 123 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ), \
4d0f3cd6 124 NULL \
82a5f02c 125 ),
4d0f3cd6 126
aa6f64c7 127#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
2e4df4bf 128 DECLARE_EVENT_TABLE_ENTRY( \
4d0f3cd6 129 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \
aa6f64c7 130 winid, \
4d0f3cd6 131 -1, \
3a818b15 132 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxNotebookEventFunction, &fn ), \
4d0f3cd6 133 NULL \
82a5f02c 134 ),
4d0f3cd6
VZ
135
136// ----------------------------------------------------------------------------
137// wxNotebook class itself
138// ----------------------------------------------------------------------------
139
1e6feb95
VZ
140#if defined(__WXUNIVERSAL__)
141 #include "wx/univ/notebook.h"
142#elif defined(__WXMSW__)
aaace873 143 #include "wx/msw/notebook.h"
2049ba38 144#elif defined(__WXMOTIF__)
1e6feb95 145 #include "wx/generic/notebook.h"
2049ba38 146#elif defined(__WXGTK__)
1e6feb95 147 #include "wx/gtk/notebook.h"
34138703 148#elif defined(__WXMAC__)
1e6feb95 149 #include "wx/mac/notebook.h"
0201182b 150#elif defined(__WXCOCOA__)
0754a4b3 151 #include "wx/cocoa/notebook.h"
1777b9bb 152#elif defined(__WXPM__)
1e6feb95 153 #include "wx/os2/notebook.h"
53b28675
RR
154#endif
155
1e6feb95
VZ
156#endif // wxUSE_NOTEBOOK
157
53b28675 158#endif
34138703 159 // _WX_NOTEBOOK_H_BASE_