]>
Commit | Line | Data |
---|---|---|
30954328 | 1 | ///////////////////////////////////////////////////////////////////////////// |
566d84a7 | 2 | // Name: wx/gtk/scrolwin.h |
30954328 RR |
3 | // Purpose: wxScrolledWindow class |
4 | // Author: Robert Roebling | |
5 | // Modified by: | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Robert Roebling | |
9 | // Licence: wxWindows license | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_GTK_SCROLLWIN_H_ | |
13 | #define _WX_GTK_SCROLLWIN_H_ | |
14 | ||
15 | #ifdef __GNUG__ | |
16 | #pragma interface "scrolwin.h" | |
17 | #endif | |
18 | ||
19 | // ---------------------------------------------------------------------------- | |
20 | // headers and constants | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
23 | #include "wx/window.h" | |
24 | #include "wx/panel.h" | |
25 | ||
26 | WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr; | |
27 | ||
28 | // default scrolled window style | |
fa3541bd | 29 | #ifndef wxScrolledWindowStyle |
30954328 | 30 | #define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL) |
fa3541bd | 31 | #endif |
30954328 RR |
32 | |
33 | // ---------------------------------------------------------------------------- | |
34 | // wxScrolledWindow | |
35 | // ---------------------------------------------------------------------------- | |
36 | ||
37 | class WXDLLEXPORT wxScrolledWindow : public wxPanel | |
38 | { | |
39 | public: | |
830ed6d9 RR |
40 | wxScrolledWindow() |
41 | { Init(); } | |
29149a64 | 42 | |
30954328 RR |
43 | wxScrolledWindow(wxWindow *parent, |
44 | wxWindowID id = -1, | |
45 | const wxPoint& pos = wxDefaultPosition, | |
46 | const wxSize& size = wxDefaultSize, | |
47 | long style = wxScrolledWindowStyle, | |
48 | const wxString& name = wxPanelNameStr) | |
830ed6d9 | 49 | { Create(parent, id, pos, size, style, name); } |
29149a64 | 50 | |
830ed6d9 | 51 | void Init(); |
30954328 RR |
52 | |
53 | bool Create(wxWindow *parent, | |
54 | wxWindowID id, | |
55 | const wxPoint& pos = wxDefaultPosition, | |
56 | const wxSize& size = wxDefaultSize, | |
57 | long style = wxScrolledWindowStyle, | |
58 | const wxString& name = wxPanelNameStr); | |
59 | ||
60 | // Normally the wxScrolledWindow will scroll itself, but in | |
61 | // some rare occasions you might want it to scroll another | |
62 | // window (e.g. a child of it in order to scroll only a portion | |
63 | // the area between the scrollbars (spreadsheet: only cell area | |
64 | // will move). | |
13ff9344 | 65 | virtual void SetTargetWindow( wxWindow *target, bool pushEventHandler = FALSE ); |
30954328 RR |
66 | virtual wxWindow *GetTargetWindow(); |
67 | ||
566d84a7 RL |
68 | // Set the scrolled area of the window. |
69 | virtual void DoSetVirtualSize( int x, int y ); | |
70 | ||
71 | // Set the x, y scrolling increments. | |
72 | void SetScrollRate( int xstep, int ystep ); | |
73 | ||
30954328 RR |
74 | // Number of pixels per user unit (0 or -1 for no scrollbar) |
75 | // Length of virtual canvas in user units | |
76 | // Length of page in user units | |
566d84a7 RL |
77 | // Default action is to set the virtual size and alter scrollbars |
78 | // accordingly. | |
30954328 RR |
79 | virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY, |
80 | int noUnitsX, int noUnitsY, | |
81 | int xPos = 0, int yPos = 0, | |
82 | bool noRefresh = FALSE ); | |
83 | ||
84 | // Physically scroll the window | |
85 | virtual void Scroll(int x_pos, int y_pos); | |
86 | ||
87 | int GetScrollPageSize(int orient) const; | |
88 | void SetScrollPageSize(int orient, int pageSize); | |
89 | ||
90 | virtual void GetScrollPixelsPerUnit(int *x_unit, int *y_unit) const; | |
91 | ||
92 | // Enable/disable Windows scrolling in either direction. | |
93 | // If TRUE, wxWindows scrolls the canvas and only a bit of | |
94 | // the canvas is invalidated; no Clear() is necessary. | |
95 | // If FALSE, the whole canvas is invalidated and a Clear() is | |
96 | // necessary. Disable for when the scroll increment is used | |
97 | // to actually scroll a non-constant distance | |
98 | virtual void EnableScrolling(bool x_scrolling, bool y_scrolling); | |
99 | ||
100 | // Get the view start | |
101 | virtual void GetViewStart(int *x, int *y) const; | |
102 | // Compatibility | |
103 | void ViewStart(int *x, int *y) const | |
104 | { GetViewStart( x, y ); } | |
105 | ||
8c2f3797 VS |
106 | // translate between scrolled and unscrolled coordinates |
107 | void CalcScrolledPosition(int x, int y, int *xx, int *yy) const | |
108 | { DoCalcScrolledPosition(x, y, xx, yy); } | |
109 | wxPoint CalcScrolledPosition(const wxPoint& pt) const | |
110 | { | |
111 | wxPoint p2; | |
112 | DoCalcScrolledPosition(pt.x, pt.y, &p2.x, &p2.y); | |
113 | return p2; | |
114 | } | |
115 | ||
116 | void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const | |
117 | { DoCalcUnscrolledPosition(x, y, xx, yy); } | |
118 | wxPoint CalcUnscrolledPosition(const wxPoint& pt) const | |
119 | { | |
120 | wxPoint p2; | |
121 | DoCalcUnscrolledPosition(pt.x, pt.y, &p2.x, &p2.y); | |
122 | return p2; | |
123 | } | |
124 | ||
125 | virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const; | |
126 | virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const; | |
30954328 RR |
127 | |
128 | // Override this function to draw the graphic (or just process EVT_PAINT) | |
129 | virtual void OnDraw(wxDC& WXUNUSED(dc)) {} | |
130 | ||
131 | // Override this function if you don't want to have wxScrolledWindow | |
132 | // automatically change the origin according to the scroll position. | |
133 | virtual void PrepareDC(wxDC& dc); | |
134 | ||
30486297 RD |
135 | // lay out the window and its children |
136 | virtual bool Layout(); | |
137 | ||
30954328 RR |
138 | // Adjust the scrollbars |
139 | virtual void AdjustScrollbars(); | |
29149a64 | 140 | |
d9a4f620 RR |
141 | // Set the scale factor, used in PrepareDC |
142 | void SetScale(double xs, double ys) { m_scaleX = xs; m_scaleY = ys; } | |
143 | double GetScaleX() const { return m_scaleX; } | |
144 | double GetScaleY() const { return m_scaleY; } | |
145 | ||
30954328 | 146 | // implementation from now on |
d9a4f620 | 147 | void OnScroll(wxScrollWinEvent& event); |
30954328 RR |
148 | void OnSize(wxSizeEvent& event); |
149 | void OnPaint(wxPaintEvent& event); | |
150 | void OnChar(wxKeyEvent& event); | |
29149a64 | 151 | |
9e691f46 VZ |
152 | void GtkVScroll( float value, unsigned int scroll_type ); |
153 | void GtkHScroll( float value, unsigned int scroll_type ); | |
830ed6d9 RR |
154 | void GtkVConnectEvent(); |
155 | void GtkHConnectEvent(); | |
156 | void GtkVDisconnectEvent(); | |
157 | void GtkHDisconnectEvent(); | |
30954328 | 158 | |
d9a4f620 RR |
159 | // Calculate scroll increment |
160 | virtual int CalcScrollInc(wxScrollWinEvent& event); | |
29149a64 | 161 | |
0bc0cd5d RR |
162 | // Overridden from wxWindows due callback being static |
163 | virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ); | |
29149a64 | 164 | |
30954328 RR |
165 | protected: |
166 | wxWindow *m_targetWindow; | |
167 | int m_xScrollPixelsPerLine; | |
168 | int m_yScrollPixelsPerLine; | |
169 | bool m_xScrollingEnabled; | |
170 | bool m_yScrollingEnabled; | |
566d84a7 RL |
171 | |
172 | // FIXME: these next four members are duplicated in the GtkAdjustment | |
173 | // members of wxWindow. Can they be safely removed from here? | |
174 | ||
30954328 RR |
175 | int m_xScrollPosition; |
176 | int m_yScrollPosition; | |
30954328 RR |
177 | int m_xScrollLinesPerPage; |
178 | int m_yScrollLinesPerPage; | |
29149a64 | 179 | |
d9a4f620 | 180 | double m_scaleY,m_scaleX; |
30954328 RR |
181 | |
182 | private: | |
183 | DECLARE_EVENT_TABLE() | |
184 | DECLARE_ABSTRACT_CLASS(wxScrolledWindow) | |
185 | }; | |
186 | ||
187 | #endif | |
188 | // _WX_GTK_SCROLLWIN_H_ | |
566d84a7 RL |
189 | |
190 | // vi:sts=4:sw=4:et |