Remove the wxPython-only doc snippets from the C++ docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71170 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
parent
eb5730bdce
commit
e5e10e234e
@ -196,8 +196,6 @@ ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image ht
|
||||
# See ENABLED_SECTIONS configuration key for more info about these:
|
||||
ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
|
||||
ALIASES += endWxPerlOnly="\endif"
|
||||
ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
|
||||
ALIASES += endWxPythonOnly="\endif"
|
||||
|
||||
# This is to get around a bug in Doxygen that prevents use of '{' or '}'
|
||||
# inside of any aliased command in parameters.
|
||||
|
@ -556,18 +556,6 @@ This example reverse-iterates through all visible items:
|
||||
|
||||
@endcode
|
||||
|
||||
@beginWxPythonOnly
|
||||
PropertyGridInterface has some useful pythonic iterators as attributes.
|
||||
@c Properties lets you iterate through all items that are not category
|
||||
captions or private children. @c Items lets you iterate through everything
|
||||
except private children. Also, there are GetPyIterator() and GetPyVIterator(),
|
||||
which return pythonic iterators instead of normal wxPropertyGridIterator.
|
||||
|
||||
If you need to use C++ style iterators in wxPython code, note that
|
||||
Instead of ++ operator, use Next() method, and instead of
|
||||
* operator, use GetProperty() method.
|
||||
@endWxPythonOnly
|
||||
|
||||
GetIterator() only works with wxPropertyGrid and the individual pages
|
||||
of wxPropertyGridManager. In order to iterate through an arbitrary
|
||||
property container (such as entire wxPropertyGridManager), you need to use
|
||||
|
@ -710,19 +710,11 @@ public:
|
||||
|
||||
/**
|
||||
Constructs a mask from a monochrome bitmap.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This is the default constructor for wxMask in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxMask(const wxBitmap& bitmap);
|
||||
|
||||
/**
|
||||
Constructs a mask from a bitmap and a colour that indicates the background.
|
||||
|
||||
@beginWxPythonOnly
|
||||
wxPython has an alternate wxMask constructor matching this form called wxMaskColour.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxMask(const wxBitmap& bitmap, const wxColour& colour);
|
||||
|
||||
|
@ -71,14 +71,6 @@ public:
|
||||
|
||||
@remarks Use ShowModal() to show the dialog.
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
For Python the two parameters @a n and @a choices are collapsed into a
|
||||
multi parameter @a choices which is expected to be a Python list of
|
||||
strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -109,14 +101,6 @@ public:
|
||||
|
||||
@remarks Use ShowModal() to show the dialog.
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
For Python the two parameters @a n and @a choices are collapsed into a
|
||||
multi parameter @a choices which is expected to be a Python list of
|
||||
strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Use an array reference for the @a choices parameter.
|
||||
@endWxPerlOnly
|
||||
@ -199,14 +183,6 @@ public:
|
||||
|
||||
@remarks Use ShowModal() to show the dialog.
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
For Python the two parameters @a n and @a choices are collapsed into a
|
||||
multi parameter @a choices which is expected to be a Python list of
|
||||
strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -242,14 +218,6 @@ public:
|
||||
|
||||
@remarks Use ShowModal() to show the dialog.
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
For Python the two parameters @a n and @a choices are collapsed into a
|
||||
multi parameter @a choices which is expected to be a Python list of
|
||||
strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Use an array reference for the @a choices parameter.
|
||||
@endWxPerlOnly
|
||||
|
@ -66,13 +66,6 @@ public:
|
||||
|
||||
@see Create(), wxValidator
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
The wxChoice constructor in wxPython reduces the @a n and @a choices
|
||||
arguments to a single argument, which is a list of strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -108,13 +101,6 @@ public:
|
||||
|
||||
@see Create(), wxValidator
|
||||
|
||||
@beginWxPythonOnly
|
||||
|
||||
The wxChoice constructor in wxPython reduces the @a n and @a choices
|
||||
arguments to a single argument, which is a list of strings.
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Use an array reference for the @a choices parameter.
|
||||
@endWxPerlOnly
|
||||
|
@ -116,11 +116,6 @@ public:
|
||||
@param name
|
||||
Window name.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxComboBox constructor in wxPython reduces the @a n and @a choices
|
||||
arguments are to a single argument, which is a list of strings.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -159,11 +154,6 @@ public:
|
||||
@param name
|
||||
Window name.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxComboBox constructor in wxPython reduces the @a n and @a choices
|
||||
arguments are to a single argument, which is a list of strings.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Use an array reference for the @a choices parameter.
|
||||
@endWxPerlOnly
|
||||
@ -259,11 +249,6 @@ public:
|
||||
|
||||
/**
|
||||
Same as wxTextEntry::SetSelection().
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is called SetMark() in wxPython, "SetSelection" is kept for
|
||||
wxControlWithItems::SetSelection().
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual void SetSelection(long from, long to);
|
||||
|
||||
|
@ -240,19 +240,6 @@
|
||||
contain an arbitrary path (either relative or absolute), not just the
|
||||
key name.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In place of a single overloaded method name, wxPython implements the
|
||||
following methods:
|
||||
- Read(key, default="") - Returns a string.
|
||||
- ReadInt(key, default=0) - Returns an integer.
|
||||
- ReadFloat(key, default=0.0) - Returns a floating point number.
|
||||
- ReadBool(key, default=0) - Returns a boolean.
|
||||
- Write(key, value) - Writes a string.
|
||||
- WriteInt(key, value) - Writes an int.
|
||||
- WriteFloat(key, value) - Writes a floating point number.
|
||||
@endWxPythonOnly
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{cfg}
|
||||
|
||||
@ -373,11 +360,6 @@ public:
|
||||
/**
|
||||
Gets the first entry.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method returns a 3-tuple consisting of the
|
||||
continue flag, the value string, and the index for the next call.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no parameters and returns a 3-element
|
||||
list (continue_flag, string, index_for_getnextentry).
|
||||
@ -388,11 +370,6 @@ public:
|
||||
/**
|
||||
Gets the first group.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method returns a 3-tuple consisting of the
|
||||
continue flag, the value string, and the index for the next call.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no parameters and returns a 3-element
|
||||
list (continue_flag, string, index_for_getnextentry).
|
||||
@ -403,11 +380,6 @@ public:
|
||||
/**
|
||||
Gets the next entry.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method returns a 3-tuple consisting of the
|
||||
continue flag, the value string, and the index for the next call.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a index parameter and
|
||||
returns a 3-element list (continue_flag, string,
|
||||
@ -419,11 +391,6 @@ public:
|
||||
/**
|
||||
Gets the next group.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method returns a 3-tuple consisting of the
|
||||
continue flag, the value string, and the index for the next call.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a index parameter and
|
||||
returns a 3-element list (continue_flag, string,
|
||||
|
@ -204,11 +204,6 @@ public:
|
||||
objects which only render their data or only set it (i.e. work in only one
|
||||
direction), should return 0 from GetFormatCount().
|
||||
|
||||
@beginWxPythonOnly
|
||||
At this time this class is not directly usable from wxPython. Derive a
|
||||
class from wxPyDataObjectSimple() instead.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
This class is not currently usable from wxPerl; you may use
|
||||
Wx::PlDataObjectSimple instead.
|
||||
@ -378,22 +373,12 @@ public:
|
||||
|
||||
/**
|
||||
Set the data. The data object will make an internal copy.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method expects a string in wxPython. You can pass nearly any
|
||||
object by pickling it first.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual bool SetData(size_t size, const void* data);
|
||||
|
||||
/**
|
||||
Like SetData(), but doesn't copy the data - instead the object takes
|
||||
ownership of the pointer.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method expects a string in wxPython. You can pass nearly any
|
||||
object by pickling it first.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
void TakeData(size_t size, void* data);
|
||||
};
|
||||
@ -525,12 +510,6 @@ public:
|
||||
be set must override SetData(). Of course, the objects supporting both
|
||||
operations must override all three methods.
|
||||
|
||||
@beginWxPythonOnly
|
||||
If you wish to create a derived wxDataObjectSimple class in wxPython you
|
||||
should derive the class from wxPyDataObjectSimple in order to get
|
||||
Python-aware capabilities for the various virtual methods.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl, you need to derive your data object class from
|
||||
Wx::PlDataObjectSimple.
|
||||
@ -555,11 +534,6 @@ public:
|
||||
Copy the data to the buffer, return @true on success.
|
||||
Must be implemented in the derived class if the object supports rendering
|
||||
its data.
|
||||
|
||||
@beginWxPythonOnly
|
||||
When implementing this method in wxPython, no additional parameters are
|
||||
required and the data should be returned from the method as a string.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual bool GetDataHere(void* buf) const;
|
||||
|
||||
@ -579,11 +553,6 @@ public:
|
||||
Copy the data from the buffer, return @true on success.
|
||||
Must be implemented in the derived class if the object supports setting
|
||||
its data.
|
||||
|
||||
@beginWxPythonOnly
|
||||
When implementing this method in wxPython, the data comes as a single
|
||||
string parameter rather than the two shown here.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual bool SetData(size_t len, const void* buf);
|
||||
|
||||
@ -607,12 +576,6 @@ public:
|
||||
This class may be used as is, but GetBitmap() may be overridden to increase
|
||||
efficiency.
|
||||
|
||||
@beginWxPythonOnly
|
||||
If you wish to create a derived wxBitmapDataObject class in wxPython you
|
||||
should derive the class from wxPyBitmapDataObject in order to get
|
||||
Python-aware capabilities for the various virtual methods.
|
||||
@endWxPythonOnly
|
||||
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
@ -702,12 +665,6 @@ public:
|
||||
wxStrings is already a very efficient operation (data is not actually
|
||||
copied because wxStrings are reference counted).
|
||||
|
||||
@beginWxPythonOnly
|
||||
If you wish to create a derived wxTextDataObject class in wxPython you
|
||||
should derive the class from wxPyTextDataObject in order to get
|
||||
Python-aware capabilities for the various virtual methods.
|
||||
@endWxPythonOnly
|
||||
|
||||
@library{wxcore}
|
||||
@category{dnd}
|
||||
|
||||
|
@ -29,12 +29,6 @@
|
||||
parameter, it is currently ignored as only the Gregorian calendar is
|
||||
supported. Future versions will support other calendars.
|
||||
|
||||
@beginWxPythonOnly
|
||||
These methods are standalone functions named
|
||||
"wxDateTime_<StaticMethodName>" in wxPython.
|
||||
@endWxPythonOnly
|
||||
|
||||
|
||||
@section datetime_formatting Date Formatting and Parsing
|
||||
|
||||
The date formatting and parsing functions convert wxDateTime objects to and
|
||||
@ -446,41 +440,23 @@ public:
|
||||
|
||||
/**
|
||||
Same as Set().
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is named "wxDateTimeFromTimeT" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime(time_t timet);
|
||||
/**
|
||||
Same as Set().
|
||||
|
||||
@beginWxPythonOnly Unsupported. @endWxPythonOnly
|
||||
*/
|
||||
wxDateTime(const struct tm& tm);
|
||||
/**
|
||||
Same as Set().
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is named "wxDateTimeFromJDN" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime(double jdn);
|
||||
/**
|
||||
Same as Set().
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is named "wxDateTimeFromHMS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime(wxDateTime_t hour, wxDateTime_t minute = 0,
|
||||
wxDateTime_t second = 0, wxDateTime_t millisec = 0);
|
||||
/**
|
||||
Same as Set().
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is named "wxDateTimeFromDMY" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime(wxDateTime_t day, Month month,
|
||||
int year = Inv_Year, wxDateTime_t hour = 0,
|
||||
@ -507,17 +483,11 @@ public:
|
||||
/**
|
||||
Constructs the object from @a timet value holding the number of seconds
|
||||
since Jan 1, 1970.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SetTimeT" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Set(time_t timet);
|
||||
/**
|
||||
Sets the date and time from the broken down representation in the
|
||||
standard @a tm structure.
|
||||
|
||||
@beginWxPythonOnly Unsupported. @endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Set(const struct tm& tm);
|
||||
|
||||
@ -534,19 +504,11 @@ public:
|
||||
particular instant is the fractional number of days since 12 hours
|
||||
Universal Coordinated Time (Greenwich mean noon) on January 1 of the
|
||||
year -4712 in the Julian proleptic calendar.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SetJDN" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Set(double jdn);
|
||||
/**
|
||||
Sets the date to be equal to Today() and the time from supplied
|
||||
parameters.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SetHMS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Set(wxDateTime_t hour, wxDateTime_t minute = 0,
|
||||
wxDateTime_t second = 0, wxDateTime_t millisec = 0);
|
||||
@ -848,67 +810,35 @@ public:
|
||||
|
||||
/**
|
||||
Adds the given date span to this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "AddDS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime Add(const wxDateSpan& diff) const;
|
||||
/**
|
||||
Adds the given date span to this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "AddDS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime Add(const wxDateSpan& diff);
|
||||
/**
|
||||
Adds the given time span to this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "AddTS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime Add(const wxTimeSpan& diff) const;
|
||||
/**
|
||||
Adds the given time span to this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "AddTS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Add(const wxTimeSpan& diff);
|
||||
|
||||
/**
|
||||
Subtracts the given time span from this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SubtractTS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime Subtract(const wxTimeSpan& diff) const;
|
||||
/**
|
||||
Subtracts the given time span from this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SubtractTS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Subtract(const wxTimeSpan& diff);
|
||||
/**
|
||||
Subtracts the given date span from this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SubtractDS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime Subtract(const wxDateSpan& diff) const;
|
||||
/**
|
||||
Subtracts the given date span from this object.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "SubtractDS" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDateTime& Subtract(const wxDateSpan& diff);
|
||||
/**
|
||||
@ -1520,20 +1450,12 @@ public:
|
||||
/**
|
||||
Returns the number of days in the given year. The only supported value
|
||||
for @a cal currently is @c Gregorian.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "GetNumberOfDaysInYear" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
static wxDateTime_t GetNumberOfDays(int year, Calendar cal = Gregorian);
|
||||
|
||||
/**
|
||||
Returns the number of days in the given month of the given year. The
|
||||
only supported value for @a cal currently is @c Gregorian.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method is named "GetNumberOfDaysInMonth" in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
static wxDateTime_t GetNumberOfDays(Month month, int year = Inv_Year,
|
||||
Calendar cal = Gregorian);
|
||||
|
@ -409,11 +409,6 @@ public:
|
||||
Draws lines using an array of points of size @a n adding the optional
|
||||
offset coordinate. The current pen is used for drawing the lines.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method accepts a Python list of wxPoint
|
||||
objects.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -425,11 +420,6 @@ public:
|
||||
coordinate. The programmer is responsible for deleting the list of
|
||||
points.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method accepts a Python list of wxPoint
|
||||
objects.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
The wxPerl version of this method accepts
|
||||
as its first parameter a reference to an array
|
||||
@ -481,11 +471,6 @@ public:
|
||||
|
||||
The programmer is responsible for deleting the list of points.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method accepts a Python list of wxPoint
|
||||
objects.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
The wxPerl version of this method accepts
|
||||
as its first parameter a reference to an array
|
||||
@ -518,10 +503,6 @@ public:
|
||||
call to DrawPolyPolygon() must be closed. Unlike polygons created by
|
||||
the DrawPolygon() member function, the polygons created by this
|
||||
method are not closed automatically.
|
||||
|
||||
@beginWxPythonOnly
|
||||
Not implemented yet.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
void DrawPolyPolygon(int n, int count[], wxPoint points[],
|
||||
wxCoord xoffset = 0, wxCoord yoffset = 0,
|
||||
@ -594,11 +575,6 @@ public:
|
||||
/**
|
||||
Draws a spline between all given points using the current pen.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method accepts a Python list of wxPoint
|
||||
objects.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
Not supported by wxPerl.
|
||||
@endWxPerlOnly
|
||||
@ -753,11 +729,6 @@ public:
|
||||
|
||||
/**
|
||||
Gets the rectangle surrounding the current clipping region.
|
||||
|
||||
@beginWxPythonOnly
|
||||
No arguments are required and the four values defining the rectangle
|
||||
are returned as a tuple.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height) const;
|
||||
|
||||
@ -883,11 +854,6 @@ public:
|
||||
function that is faster or more accurate than the generic
|
||||
implementation then it should be used instead.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method only takes the @a text parameter and returns a Python list
|
||||
of integers.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a text parameter and
|
||||
returns the widths as a list of integers.
|
||||
@ -914,13 +880,6 @@ public:
|
||||
|
||||
@note This function only works with single-line strings.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The following methods are implemented in wxPython:
|
||||
- GetTextExtent(string) - Returns a 2-tuple, (width, height).
|
||||
- GetFullTextExtent(string, font=NULL) -
|
||||
Returns a 4-tuple, (width, height, descent, externalLeading).
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method is implemented as GetTextExtent(string,
|
||||
font = undef) returning a 4-element list (width, height,
|
||||
@ -1388,10 +1347,6 @@ public:
|
||||
|
||||
@note This method shouldn't be used with wxPaintDC as accessing the DC
|
||||
while drawing can result in unexpected results, notably in wxGTK.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxColour value is returned and is not required as a parameter.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
bool GetPixel(wxCoord x, wxCoord y, wxColour* colour) const;
|
||||
|
||||
@ -1416,13 +1371,6 @@ public:
|
||||
dc.SetUserScale(min(scaleX, scaleY),min(scaleX, scaleY));
|
||||
@endcode
|
||||
|
||||
@beginWxPythonOnly
|
||||
In place of a single overloaded method name, wxPython implements the
|
||||
following methods:
|
||||
- GetSize() - Returns a wxSize.
|
||||
- GetSizeWH() - Returns a 2-tuple (width, height).
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl there are two methods instead of a single overloaded
|
||||
method:
|
||||
|
@ -16,11 +16,6 @@
|
||||
platforms, wxGenericDragImage is used. Applications may also prefer to use
|
||||
wxGenericDragImage on Windows, too.
|
||||
|
||||
@beginWxPythonOnly
|
||||
wxPython uses wxGenericDragImage on all platforms, but uses the wxDragImage
|
||||
name.
|
||||
@endWxPythonOnly
|
||||
|
||||
To use this class, when you wish to start dragging an image, create a
|
||||
wxDragImage object and store it somewhere you can access it as the drag
|
||||
progresses. Call BeginDrag() to start, and EndDrag() to stop the drag. To
|
||||
@ -65,10 +60,6 @@ public:
|
||||
Icon to be used as the drag image.
|
||||
@param cursor
|
||||
Optional cursor to combine with the image.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is called wxDragIcon in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor);
|
||||
/**
|
||||
@ -78,10 +69,6 @@ public:
|
||||
Text used to construct a drag image.
|
||||
@param cursor
|
||||
Optional cursor to combine with the image.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is called wxDragString in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDragImage(const wxString& text, const wxCursor& cursor = wxNullCursor);
|
||||
/**
|
||||
@ -92,10 +79,6 @@ public:
|
||||
Tree control for constructing a tree drag image.
|
||||
@param id
|
||||
Tree control item id.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is called wxDragTreeItem in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
|
||||
/**
|
||||
@ -106,10 +89,6 @@ public:
|
||||
List control for constructing a list drag image.
|
||||
@param id
|
||||
List control item id.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This constructor is called wxDragListItem in wxPython.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxDragImage(const wxListCtrl& listCtrl, long id);
|
||||
/**
|
||||
|
@ -791,11 +791,6 @@ wxColourDatabase* wxTheColourDatabase;
|
||||
almost equivalent to wxSize, has a different meaning: wxPoint represents a
|
||||
position while wxSize represents the size.
|
||||
|
||||
@beginWxPythonOnly
|
||||
wxPython defines aliases for the @e x and @e y members named @e width and
|
||||
@e height since it makes much more sense for sizes.
|
||||
@endWxPythonOnly
|
||||
|
||||
@library{wxcore}
|
||||
@category{data}
|
||||
|
||||
|
@ -641,10 +641,6 @@ public:
|
||||
Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below,
|
||||
which do most of the scaling calculations for you.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method returns the output-only parameters as a tuple.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no arguments and returns a
|
||||
2-element list (w, h).
|
||||
@ -661,10 +657,6 @@ public:
|
||||
If you are doing your own scaling, remember to multiply this by a scaling
|
||||
factor to take the preview DC size into account.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method returns the output-only parameters as a tuple.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no arguments and returns a
|
||||
2-element list (w, h).
|
||||
@ -682,12 +674,6 @@ public:
|
||||
|
||||
@a minPage must be greater than zero and @a maxPage must be greater
|
||||
than @a minPage.
|
||||
|
||||
@beginWxPythonOnly
|
||||
When this method is implemented in a derived Python class, it should be designed
|
||||
to take no parameters (other than the self reference) and to return a tuple of
|
||||
four integers.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual void GetPageInfo(int* minPage, int* maxPage, int* pageFrom,
|
||||
int* pageTo);
|
||||
@ -695,10 +681,6 @@ public:
|
||||
/**
|
||||
Returns the size of the printer page in millimetres.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method returns the output-only parameters as a tuple.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no arguments and returns a
|
||||
2-element list (w, h).
|
||||
@ -715,15 +697,6 @@ public:
|
||||
previewing, a memory device context is used, which uses a bitmap size reflecting
|
||||
the current preview zoom. The application must take this discrepancy into
|
||||
account if previewing is to be supported.
|
||||
|
||||
@beginWxPythonOnly
|
||||
This method returns the output-only parameters as a tuple.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no arguments and returns a
|
||||
2-element list (w, h).
|
||||
@endWxPerlOnly
|
||||
*/
|
||||
void GetPageSizePixels(int* w, int* h) const;
|
||||
|
||||
@ -846,11 +819,6 @@ public:
|
||||
@remarks
|
||||
The base OnBeginDocument() must be called (and the return value
|
||||
checked) from within the overridden function, since it calls wxDC::StartDoc().
|
||||
|
||||
@beginWxPythonOnly
|
||||
If this method is overridden in a Python class then the base class version can
|
||||
be called by using the method <tt>base_OnBeginDocument(startPage, endPage)</tt>.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual bool OnBeginDocument(int startPage, int endPage);
|
||||
|
||||
|
@ -230,14 +230,6 @@ public:
|
||||
Property to start iteration from. If @NULL, then first child of root
|
||||
is used.
|
||||
|
||||
@beginWxPythonOnly
|
||||
Instead of ++ operator, use Next() method, and instead of * operator,
|
||||
use GetProperty() method. There is also GetPyIterator() method (which
|
||||
takes the same arguments but instead returns a pythonic iterator),
|
||||
@c Properties attribute which is an iterator over all non-category,
|
||||
non-private properties, and finally @c Items attribute which is an
|
||||
iterator over all items except private child properties.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT,
|
||||
wxPGProperty* firstProp = NULL );
|
||||
@ -257,14 +249,6 @@ public:
|
||||
from the first property from the top, and wxBOTTOM means that the
|
||||
iteration will instead begin from bottommost valid item.
|
||||
|
||||
@beginWxPythonOnly
|
||||
Instead of ++ operator, use Next() method, and instead of * operator,
|
||||
use GetProperty() method. There is also GetPyIterator() method (which
|
||||
takes the same arguments but instead returns a pythonic iterator),
|
||||
@c Properties attribute which is an iterator over all non-category,
|
||||
non-private properties, and finally @c Items attribute which is an
|
||||
iterator over all items except private child properties.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxPropertyGridIterator GetIterator( int flags, int startPos );
|
||||
wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const;
|
||||
@ -469,15 +453,6 @@ public:
|
||||
|
||||
@param flags
|
||||
See @ref propgrid_iterator_flags.
|
||||
|
||||
@beginWxPythonOnly
|
||||
Instead of ++ operator, use Next() method, and instead of * operator,
|
||||
use GetProperty() method. There is also GetPyVIterator() method (which
|
||||
takes the same arguments but instead returns a pythonic iterator),
|
||||
@c Properties attribute which is an iterator over all non-category,
|
||||
non-private properties, and finally @c Items attribute which is an
|
||||
iterator over all items except private child properties.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual wxPGVIterator GetVIterator( int flags ) const;
|
||||
|
||||
|
@ -182,15 +182,6 @@ public:
|
||||
|
||||
@see wxWindow::Enable()
|
||||
|
||||
@beginWxPythonOnly
|
||||
In place of a single overloaded method name, wxPython implements the following methods:
|
||||
|
||||
@beginTable
|
||||
@row2col{Enable(flag), Enables or disables the entire radiobox.}
|
||||
@row2col{EnableItem(n\, flag), Enables or disables an individual button in the radiobox.}
|
||||
@endTable
|
||||
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
virtual bool Enable(unsigned int n, bool enable = true);
|
||||
|
||||
@ -311,16 +302,6 @@ public:
|
||||
@see
|
||||
wxWindow::Show()
|
||||
|
||||
@beginWxPythonOnly
|
||||
In place of a single overloaded method name, wxPython implements the following methods:
|
||||
|
||||
@beginTable
|
||||
@row2col{Show(flag), Shows or hides the entire radiobox.}
|
||||
@row2col{ShowItem(n\, flag), Shows or hides individual buttons.}
|
||||
@endTable
|
||||
|
||||
@endWxPythonOnly
|
||||
|
||||
*/
|
||||
virtual bool Show(unsigned int item, bool show = true);
|
||||
|
||||
|
@ -115,10 +115,6 @@ public:
|
||||
|
||||
/**
|
||||
Increment operator. Increments the iterator to the next region.
|
||||
|
||||
@beginWxPythonOnly
|
||||
A wxPython alias for this operator is called Next.
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxRegionIterator& operator ++();
|
||||
|
||||
|
@ -49,12 +49,6 @@
|
||||
window, the library wouldn't be able to delete such an orphan sizer and in
|
||||
this, and only this, case it should be deleted explicitly.
|
||||
|
||||
@beginWxPythonOnly
|
||||
If you wish to create a sizer class in wxPython you should
|
||||
derive the class from @c wxPySizer in order to get Python-aware
|
||||
capabilities for the various virtual methods.
|
||||
@endWxPythonOnly
|
||||
|
||||
@section wxsizer_flags wxSizer flags
|
||||
|
||||
The "flag" argument accepted by wxSizeItem constructors and other
|
||||
|
@ -67,12 +67,6 @@ public:
|
||||
/**
|
||||
Default constructor.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The following methods are added in wxPython for accessing the object:
|
||||
- GetData(): Returns a reference to the Python Object.
|
||||
- SetData(obj): Associates a new Python Object with the wxTreeItemData.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl the constructor accepts a scalar as an optional parameter
|
||||
and stores it as client data; use
|
||||
|
@ -383,12 +383,6 @@ public:
|
||||
So, for example, the x coordinate may be negative if the tree has a
|
||||
horizontal scrollbar and its position is not 0.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method requires only the @a item and @a
|
||||
textOnly parameters. The return value is either a wxRect object or @c
|
||||
None.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a item and
|
||||
@a textOnly parameters and returns a @c Wx::Rect (or @c undef).
|
||||
@ -438,11 +432,6 @@ public:
|
||||
Returns an invalid tree item (i.e. wxTreeItemId::IsOk() returns @false)
|
||||
if there are no further children.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In wxPython the returned wxTreeItemId and the new cookie value are both
|
||||
returned as a tuple containing the two values.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a item parameter, and
|
||||
returns a 2-element list (item, cookie).
|
||||
@ -505,12 +494,6 @@ public:
|
||||
|
||||
@see wxTreeItemData
|
||||
|
||||
@beginWxPythonOnly
|
||||
wxPython provides the following shortcut method:
|
||||
@li GetPyData(item): Returns the Python Object associated with the
|
||||
wxTreeItemData for the given item Id.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
wxPerl provides the following shortcut method:
|
||||
- GetPlData(item): returns the Perl data
|
||||
@ -578,11 +561,6 @@ public:
|
||||
|
||||
Returns an invalid tree item if there are no further children.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In wxPython the returned wxTreeItemId and the new cookie value are both
|
||||
returned as a tuple containing the two values.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method returns a 2-element list
|
||||
(item, cookie) instead of modifying its parameters.
|
||||
@ -657,11 +635,6 @@ public:
|
||||
|
||||
Returns the number of selected items.
|
||||
|
||||
@beginWxPythonOnly
|
||||
The wxPython version of this method accepts no parameters and returns a
|
||||
Python list of @ref wxTreeItemId "wxTreeItemId"s.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method takes no parameters and returns a list of
|
||||
@c Wx::TreeItemId.
|
||||
@ -693,10 +666,6 @@ public:
|
||||
- @c wxTREE_HITTEST_TOLEFT: To the right of the client area.
|
||||
- @c wxTREE_HITTEST_TORIGHT: To the left of the client area.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In wxPython both the wxTreeItemId and the flags are returned as a tuple.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method only takes the @a point parameter
|
||||
and returns a 2-element list (item, flags).
|
||||
@ -729,10 +698,6 @@ public:
|
||||
image list specifying the image to use for unselected and selected
|
||||
items, respectively. If @a image -1 and @a selImage is -1, the same
|
||||
image is used for both selected and unselected items.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In wxPython, this form of this method is called @c InsertItemBefore().
|
||||
@endWxPythonOnly
|
||||
*/
|
||||
wxTreeItemId InsertItem(const wxTreeItemId& parent,
|
||||
size_t before,
|
||||
@ -875,11 +840,6 @@ public:
|
||||
multiple times for the same item will result in memory leaks unless you
|
||||
delete the old item data pointer yourself.
|
||||
|
||||
@beginWxPythonOnly
|
||||
- @b SetPyData( @a item, @c obj): Associate the given Python Object with
|
||||
the wxTreeItemData for the given item Id.
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
wxPerl provides the following shortcut method:
|
||||
- SetPlData(item, data): sets the Perl data
|
||||
|
@ -26,12 +26,6 @@
|
||||
|
||||
For more information, please see @ref overview_validator.
|
||||
|
||||
@beginWxPythonOnly
|
||||
If you wish to create a validator class in wxPython you should derive the
|
||||
class from @c wxPyValidator in order to get Python-aware capabilities for
|
||||
the various virtual methods.
|
||||
@endWxPythonOnly
|
||||
|
||||
@library{wxcore}
|
||||
@category{validator}
|
||||
|
||||
|
@ -1415,12 +1415,6 @@ public:
|
||||
A pointer to a integer value for the y coordinate. Pass the client
|
||||
coordinate in, and a screen coordinate will be passed out.
|
||||
|
||||
@beginWxPythonOnly
|
||||
In place of a single overloaded method name, wxPython implements the following methods:
|
||||
- ClientToScreen(point): Accepts and returns a wxPoint
|
||||
- ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)
|
||||
@endWxPythonOnly
|
||||
|
||||
@beginWxPerlOnly
|
||||
In wxPerl this method returns a 2-element list instead of
|
||||
modifying its parameters.
|
||||
|
Loading…
Reference in New Issue
Block a user