Files
wxWidgets/wxPython/src/_panel.i
Robin Dunn d07d2bc9d0 Some docstring additions, reformats and epydoc markup.
Removed RefDoc macros, instead made all the normal Docstring macros
take an extra parameter to be used for the optional details postion of
the docstring.  The intent is that the docstrings put in the generated
.py files checked in to CVS and delivered in releases will be only a
paragraph or two, but when used for generating the epydoc reference
docs they can optionally contain a lot more details.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27216 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2004-05-12 00:17:48 +00:00

168 lines
5.8 KiB
OpenEdge ABL

/////////////////////////////////////////////////////////////////////////////
// Name: _window.i
// Purpose: SWIG interface for wxPanel and wxScrolledWindow
//
// Author: Robin Dunn
//
// Created: 24-June-1997
// RCS-ID: $Id$
// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%{
%}
//---------------------------------------------------------------------------
%newgroup
class wxPanel : public wxWindow
{
public:
%pythonAppend wxPanel "self._setOORInfo(self)"
%pythonAppend wxPanel() ""
wxPanel(wxWindow* parent,
const wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTAB_TRAVERSAL | wxNO_BORDER,
const wxString& name = wxPyPanelNameStr);
%name(PrePanel)wxPanel();
bool Create(wxWindow* parent,
const wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTAB_TRAVERSAL | wxNO_BORDER,
const wxString& name = wxPyPanelNameStr);
void InitDialog();
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
};
//---------------------------------------------------------------------------
%newgroup
// TODO: Add wrappers for the wxScrollHelper class, make wxScrolledWindow
// derive from it and wxPanel. But what to do about wxGTK where this
// is not True?
class wxScrolledWindow : public wxPanel
{
public:
%pythonAppend wxScrolledWindow "self._setOORInfo(self)"
%pythonAppend wxScrolledWindow() ""
wxScrolledWindow(wxWindow* parent,
const wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHSCROLL | wxVSCROLL,
const wxString& name = wxPyPanelNameStr);
%name(PreScrolledWindow)wxScrolledWindow();
bool Create(wxWindow* parent,
const wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHSCROLL | wxVSCROLL,
const wxString& name = wxPyPanelNameStr);
// configure the scrolling
virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
int noUnitsX, int noUnitsY,
int xPos = 0, int yPos = 0,
bool noRefresh = False );
// scroll to the given (in logical coords) position
virtual void Scroll(int x, int y);
// get/set the page size for this orientation (wxVERTICAL/wxHORIZONTAL)
int GetScrollPageSize(int orient) const;
void SetScrollPageSize(int orient, int pageSize);
// Set the x, y scrolling increments.
void SetScrollRate( int xstep, int ystep );
DocDeclAStr(
virtual void, GetScrollPixelsPerUnit(int *OUTPUT, int *OUTPUT) const,
"GetScrollPixelsPerUnit() -> (xUnit, yUnit)",
"Get the size of one logical unit in physical units.", "");
// Enable/disable Windows scrolling in either direction. If True, wxWindows
// scrolls the canvas and only a bit of 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);
DocDeclAStr(
virtual void, GetViewStart(int *OUTPUT, int *OUTPUT) const,
"GetViewStart() -> (x,y)",
"Get the view start", "");
// Set the scale factor, used in PrepareDC
void SetScale(double xs, double ys);
double GetScaleX() const;
double GetScaleY() const;
%nokwargs CalcScrolledPosition;
%nokwargs CalcUnscrolledPosition;
DocStr(CalcScrolledPosition, "Translate between scrolled and unscrolled coordinates.", "");
wxPoint CalcScrolledPosition(const wxPoint& pt) const;
DocDeclA(
void, CalcScrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
"CalcScrolledPosition(int x, int y) -> (sx, sy)");
DocStr(CalcUnscrolledPosition, "Translate between scrolled and unscrolled coordinates.", "");
wxPoint CalcUnscrolledPosition(const wxPoint& pt) const;
DocDeclA(
void, CalcUnscrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const,
"CalcUnscrolledPosition(int x, int y) -> (ux, uy)");
// TODO: use directors?
// virtual void DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const;
// virtual void DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const;
// Adjust the scrollbars
virtual void AdjustScrollbars();
// Calculate scroll increment
virtual int CalcScrollInc(wxScrollWinEvent& event);
// Normally the wxScrolledWindow will scroll itself, but in some rare
// occasions you might want it to scroll [part of] 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).
virtual void SetTargetWindow(wxWindow *target);
virtual wxWindow *GetTargetWindow() const;
#ifndef __WXGTK__
void SetTargetRect(const wxRect& rect);
wxRect GetTargetRect() const;
#endif
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
};
//---------------------------------------------------------------------------