More docstring updates for OUTPUT parameters

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24615 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2003-11-20 20:41:31 +00:00
parent 3e778e3bde
commit 322913cef3
29 changed files with 749 additions and 662 deletions

View File

@@ -93,13 +93,10 @@ public:
// Set the x, y scrolling increments.
void SetScrollRate( int xstep, int ystep );
%feature("autodoc") GetScrollPixelsPerUnit
"GetScrollPixelsPerUnit() -> (xUnit, yUnit)";
%feature("docstring") GetScrollPixelsPerUnit "
get the size of one logical unit in physical ones
"
virtual void GetScrollPixelsPerUnit(int *OUTPUT,
int *OUTPUT) const;
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
@@ -108,9 +105,12 @@ public:
// actually scroll a non-constant distance
virtual void EnableScrolling(bool x_scrolling, bool y_scrolling);
// Get the view start
virtual void GetViewStart(int *OUTPUT, int *OUTPUT) const;
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;
@@ -120,12 +120,21 @@ public:
%nokwargs CalcScrolledPosition;
%nokwargs CalcUnscrolledPosition;
// translate between scrolled and unscrolled coordinates
void CalcScrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const;
DocStr(CalcScrolledPosition, "Translate between scrolled and unscrolled coordinates.");
wxPoint CalcScrolledPosition(const wxPoint& pt) const;
void CalcUnscrolledPosition(int x, int y, int *OUTPUT, int *OUTPUT) const;
wxPoint CalcUnscrolledPosition(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;