2001-04-29 11:27:57 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2002-04-19 18:12:38 -04:00
|
|
|
// Name: wx/gtk/scrolwin.h
|
2001-04-29 11:27:57 -04:00
|
|
|
// Purpose: wxScrolledWindow class
|
|
|
|
// Author: Robert Roebling
|
|
|
|
// Modified by:
|
|
|
|
// Created: 01/02/97
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) Robert Roebling
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
2001-04-29 11:27:57 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_GTK_SCROLLWIN_H_
|
|
|
|
#define _WX_GTK_SCROLLWIN_H_
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// headers and constants
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#include "wx/window.h"
|
|
|
|
#include "wx/panel.h"
|
|
|
|
|
|
|
|
WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
|
|
|
|
|
|
|
|
// default scrolled window style
|
2001-04-30 08:35:54 -04:00
|
|
|
#ifndef wxScrolledWindowStyle
|
2001-04-29 11:27:57 -04:00
|
|
|
#define wxScrolledWindowStyle (wxHSCROLL | wxVSCROLL)
|
2001-04-30 08:35:54 -04:00
|
|
|
#endif
|
2001-04-29 11:27:57 -04:00
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxScrolledWindow
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxScrolledWindow : public wxPanel
|
|
|
|
{
|
|
|
|
public:
|
2001-05-01 16:09:10 -04:00
|
|
|
wxScrolledWindow()
|
|
|
|
{ Init(); }
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
wxScrolledWindow(wxWindow *parent,
|
|
|
|
wxWindowID id = -1,
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
long style = wxScrolledWindowStyle,
|
|
|
|
const wxString& name = wxPanelNameStr)
|
2001-05-01 16:09:10 -04:00
|
|
|
{ Create(parent, id, pos, size, style, name); }
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2001-05-01 16:09:10 -04:00
|
|
|
void Init();
|
2001-04-29 11:27:57 -04:00
|
|
|
|
|
|
|
bool Create(wxWindow *parent,
|
|
|
|
wxWindowID id,
|
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
const wxSize& size = wxDefaultSize,
|
|
|
|
long style = wxScrolledWindowStyle,
|
|
|
|
const wxString& name = wxPanelNameStr);
|
|
|
|
|
|
|
|
// Normally the wxScrolledWindow will scroll itself, but in
|
|
|
|
// some rare occasions you might want it to scroll another
|
|
|
|
// window (e.g. a child of it in order to scroll only a portion
|
|
|
|
// the area between the scrollbars (spreadsheet: only cell area
|
|
|
|
// will move).
|
2001-12-01 07:26:27 -05:00
|
|
|
virtual void SetTargetWindow( wxWindow *target, bool pushEventHandler = FALSE );
|
2003-10-02 12:51:36 -04:00
|
|
|
virtual wxWindow *GetTargetWindow() const;
|
2001-04-29 11:27:57 -04:00
|
|
|
|
2002-04-19 18:12:38 -04:00
|
|
|
// Set the scrolled area of the window.
|
|
|
|
virtual void DoSetVirtualSize( int x, int y );
|
|
|
|
|
2005-03-17 16:21:45 -05:00
|
|
|
// wxWindow's GetBestVirtualSize returns the actual window size,
|
|
|
|
// whereas we want to return the virtual size
|
|
|
|
virtual wxSize GetBestVirtualSize() const;
|
|
|
|
|
|
|
|
// Return the size best suited for the current window
|
|
|
|
// (this isn't a virtual size, this is a sensible size for the window)
|
|
|
|
virtual wxSize DoGetBestSize() const;
|
|
|
|
|
2002-04-19 18:12:38 -04:00
|
|
|
// Set the x, y scrolling increments.
|
|
|
|
void SetScrollRate( int xstep, int ystep );
|
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
// Number of pixels per user unit (0 or -1 for no scrollbar)
|
|
|
|
// Length of virtual canvas in user units
|
|
|
|
// Length of page in user units
|
2002-04-19 18:12:38 -04:00
|
|
|
// Default action is to set the virtual size and alter scrollbars
|
|
|
|
// accordingly.
|
2001-04-29 11:27:57 -04:00
|
|
|
virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
|
|
|
|
int noUnitsX, int noUnitsY,
|
|
|
|
int xPos = 0, int yPos = 0,
|
|
|
|
bool noRefresh = FALSE );
|
|
|
|
|
|
|
|
// Physically scroll the window
|
|
|
|
virtual void Scroll(int x_pos, int y_pos);
|
|
|
|
|
|
|
|
int GetScrollPageSize(int orient) const;
|
|
|
|
void SetScrollPageSize(int orient, int pageSize);
|
|
|
|
|
|
|
|
virtual void GetScrollPixelsPerUnit(int *x_unit, int *y_unit) const;
|
|
|
|
|
|
|
|
// Enable/disable Windows scrolling in either direction.
|
2004-05-23 10:56:36 -04:00
|
|
|
// If TRUE, wxWidgets scrolls the canvas and only a bit of
|
2001-04-29 11:27:57 -04:00
|
|
|
// the canvas is invalidated; no Clear() is necessary.
|
|
|
|
// If FALSE, the whole canvas is invalidated and a Clear() is
|
|
|
|
// necessary. Disable for when the scroll increment is used
|
|
|
|
// to actually scroll a non-constant distance
|
|
|
|
virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
|
|
|
|
|
|
|
|
// Get the view start
|
|
|
|
virtual void GetViewStart(int *x, int *y) const;
|
|
|
|
|
2002-03-17 09:13:14 -05:00
|
|
|
// translate between scrolled and unscrolled coordinates
|
|
|
|
void CalcScrolledPosition(int x, int y, int *xx, int *yy) const
|
|
|
|
{ DoCalcScrolledPosition(x, y, xx, yy); }
|
|
|
|
wxPoint CalcScrolledPosition(const wxPoint& pt) const
|
|
|
|
{
|
|
|
|
wxPoint p2;
|
|
|
|
DoCalcScrolledPosition(pt.x, pt.y, &p2.x, &p2.y);
|
|
|
|
return p2;
|
|
|
|
}
|
|
|
|
|
|
|
|
void CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
|
|
|
|
{ DoCalcUnscrolledPosition(x, y, xx, yy); }
|
|
|
|
wxPoint CalcUnscrolledPosition(const wxPoint& pt) const
|
|
|
|
{
|
|
|
|
wxPoint p2;
|
|
|
|
DoCalcUnscrolledPosition(pt.x, pt.y, &p2.x, &p2.y);
|
|
|
|
return p2;
|
|
|
|
}
|
2002-06-18 08:47:40 -04:00
|
|
|
|
2002-03-17 09:13:14 -05:00
|
|
|
virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
|
|
|
|
virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
|
2001-04-29 11:27:57 -04:00
|
|
|
|
|
|
|
// Override this function to draw the graphic (or just process EVT_PAINT)
|
|
|
|
virtual void OnDraw(wxDC& WXUNUSED(dc)) {}
|
|
|
|
|
|
|
|
// Override this function if you don't want to have wxScrolledWindow
|
|
|
|
// automatically change the origin according to the scroll position.
|
2004-07-20 14:13:12 -04:00
|
|
|
void PrepareDC(wxDC& dc) { DoPrepareDC(dc); }
|
2001-04-29 11:27:57 -04:00
|
|
|
|
2002-03-14 19:21:47 -05:00
|
|
|
// lay out the window and its children
|
|
|
|
virtual bool Layout();
|
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
// Adjust the scrollbars
|
|
|
|
virtual void AdjustScrollbars();
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2001-05-01 10:32:41 -04:00
|
|
|
// Set the scale factor, used in PrepareDC
|
|
|
|
void SetScale(double xs, double ys) { m_scaleX = xs; m_scaleY = ys; }
|
|
|
|
double GetScaleX() const { return m_scaleX; }
|
|
|
|
double GetScaleY() const { return m_scaleY; }
|
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
// implementation from now on
|
2001-05-01 10:32:41 -04:00
|
|
|
void OnScroll(wxScrollWinEvent& event);
|
2001-04-29 11:27:57 -04:00
|
|
|
void OnSize(wxSizeEvent& event);
|
|
|
|
void OnPaint(wxPaintEvent& event);
|
|
|
|
void OnChar(wxKeyEvent& event);
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2002-03-12 14:24:30 -05:00
|
|
|
void GtkVScroll( float value, unsigned int scroll_type );
|
|
|
|
void GtkHScroll( float value, unsigned int scroll_type );
|
2001-05-01 16:09:10 -04:00
|
|
|
void GtkVConnectEvent();
|
|
|
|
void GtkHConnectEvent();
|
|
|
|
void GtkVDisconnectEvent();
|
|
|
|
void GtkHDisconnectEvent();
|
2001-04-29 11:27:57 -04:00
|
|
|
|
2001-05-01 10:32:41 -04:00
|
|
|
// Calculate scroll increment
|
|
|
|
virtual int CalcScrollInc(wxScrollWinEvent& event);
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2004-05-23 10:56:36 -04:00
|
|
|
// Overridden from wxWidgets due callback being static
|
2001-05-01 12:40:06 -04:00
|
|
|
virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2004-07-20 12:30:22 -04:00
|
|
|
virtual void DoPrepareDC(wxDC& dc);
|
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
protected:
|
|
|
|
wxWindow *m_targetWindow;
|
|
|
|
int m_xScrollPixelsPerLine;
|
|
|
|
int m_yScrollPixelsPerLine;
|
|
|
|
bool m_xScrollingEnabled;
|
|
|
|
bool m_yScrollingEnabled;
|
2002-04-19 18:12:38 -04:00
|
|
|
|
|
|
|
// FIXME: these next four members are duplicated in the GtkAdjustment
|
|
|
|
// members of wxWindow. Can they be safely removed from here?
|
|
|
|
|
2001-04-29 11:27:57 -04:00
|
|
|
int m_xScrollPosition;
|
|
|
|
int m_yScrollPosition;
|
|
|
|
int m_xScrollLinesPerPage;
|
|
|
|
int m_yScrollLinesPerPage;
|
2001-06-26 17:29:16 -04:00
|
|
|
|
2001-05-01 10:32:41 -04:00
|
|
|
double m_scaleY,m_scaleX;
|
2001-04-29 11:27:57 -04:00
|
|
|
|
|
|
|
private:
|
|
|
|
DECLARE_EVENT_TABLE()
|
2005-02-06 10:48:00 -05:00
|
|
|
DECLARE_DYNAMIC_CLASS(wxScrolledWindow)
|
2001-04-29 11:27:57 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|
|
|
|
// _WX_GTK_SCROLLWIN_H_
|
2002-04-19 18:12:38 -04:00
|
|
|
|
|
|
|
// vi:sts=4:sw=4:et
|