Fix Doxygen warnings due to documenting overloaded functions together.
Apparently we can't make @param statements apply just to some overloads, so document them separately now. See #15346. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74704 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -522,11 +522,9 @@ public:
|
|||||||
|
|
||||||
@param method The method to call.
|
@param method The method to call.
|
||||||
@param x1 The (optional) first parameter to pass to the method.
|
@param x1 The (optional) first parameter to pass to the method.
|
||||||
@param x2 The (optional) second parameter to pass to the method.
|
Currently, 0, 1 or 2 parameters can be passed. If you need to pass
|
||||||
|
more than 2 arguments, you can use the CallAfter<T>(const T& fn)
|
||||||
Note that currently only up to 2 arguments can be passed. For more
|
overload that can call any functor.
|
||||||
complicated needs, you can use the CallAfter<T>(const T& fn) overload
|
|
||||||
that can call any functor.
|
|
||||||
|
|
||||||
@note This method is not available with Visual C++ before version 8
|
@note This method is not available with Visual C++ before version 8
|
||||||
(Visual Studio 2005) as earlier versions of the compiler don't
|
(Visual Studio 2005) as earlier versions of the compiler don't
|
||||||
|
@@ -1300,14 +1300,34 @@ public:
|
|||||||
*/
|
*/
|
||||||
virtual bool GetStyle(long position, wxTextAttr& style);
|
virtual bool GetStyle(long position, wxTextAttr& style);
|
||||||
|
|
||||||
//@{
|
|
||||||
/**
|
/**
|
||||||
This function finds the character at the specified position expressed
|
Finds the position of the character at the specified point.
|
||||||
in pixels.
|
|
||||||
|
|
||||||
The two overloads of this method allow to find either the position of
|
If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
|
||||||
the character, as an index into the text control contents, or its row
|
character closest to this position are returned, otherwise the output
|
||||||
and column.
|
parameters are not modified.
|
||||||
|
|
||||||
|
Please note that this function is currently only implemented in wxUniv,
|
||||||
|
wxMSW and wxGTK2 ports and always returns @c wxTE_HT_UNKNOWN in the
|
||||||
|
other ports.
|
||||||
|
|
||||||
|
@beginWxPerlOnly
|
||||||
|
In wxPerl this function takes only the @a pt argument and
|
||||||
|
returns a 3-element list (result, col, row).
|
||||||
|
@endWxPerlOnly
|
||||||
|
|
||||||
|
@param pt
|
||||||
|
The position of the point to check, in window device coordinates.
|
||||||
|
@param pos
|
||||||
|
Receives the position of the character at the given position. May
|
||||||
|
be @NULL.
|
||||||
|
|
||||||
|
@see PositionToXY(), XYToPosition()
|
||||||
|
*/
|
||||||
|
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Finds the row and column of the character at the specified point.
|
||||||
|
|
||||||
If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
|
If the return code is not @c wxTE_HT_UNKNOWN the row and column of the
|
||||||
character closest to this position are returned, otherwise the output
|
character closest to this position are returned, otherwise the output
|
||||||
@@ -1330,17 +1350,12 @@ public:
|
|||||||
@param row
|
@param row
|
||||||
Receives the row of the character at the given position. May be
|
Receives the row of the character at the given position. May be
|
||||||
@NULL.
|
@NULL.
|
||||||
@param pos
|
|
||||||
Receives the position of the character at the given position. May
|
|
||||||
be @NULL.
|
|
||||||
|
|
||||||
@see PositionToXY(), XYToPosition()
|
@see PositionToXY(), XYToPosition()
|
||||||
*/
|
*/
|
||||||
wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
|
|
||||||
wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
|
wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
|
||||||
wxTextCoord *col,
|
wxTextCoord *col,
|
||||||
wxTextCoord *row) const;
|
wxTextCoord *row) const;
|
||||||
//@}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns @true if the text has been modified by user.
|
Returns @true if the text has been modified by user.
|
||||||
|
@@ -305,7 +305,21 @@ public:
|
|||||||
typedef T ValueType;
|
typedef T ValueType;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Validator constructor.
|
Constructor for validator using the default precision.
|
||||||
|
|
||||||
|
@param value
|
||||||
|
A pointer to the variable associated with the validator. If non
|
||||||
|
@NULL, this variable should have a lifetime equal to or longer than
|
||||||
|
the validator lifetime (which is usually determined by the lifetime
|
||||||
|
of the window).
|
||||||
|
@param style
|
||||||
|
A combination of wxNumValidatorStyle enum values.
|
||||||
|
*/
|
||||||
|
wxFloatingPointValidator(ValueType *value = NULL,
|
||||||
|
int style = wxNUM_VAL_DEFAULT);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Constructor for validator specifying the precision.
|
||||||
|
|
||||||
@param value
|
@param value
|
||||||
A pointer to the variable associated with the validator. If non
|
A pointer to the variable associated with the validator. If non
|
||||||
@@ -318,13 +332,9 @@ public:
|
|||||||
The number of decimal digits after the decimal separator to show
|
The number of decimal digits after the decimal separator to show
|
||||||
and accept.
|
and accept.
|
||||||
*/
|
*/
|
||||||
//@{
|
|
||||||
wxFloatingPointValidator(ValueType *value = NULL,
|
|
||||||
int style = wxNUM_VAL_DEFAULT);
|
|
||||||
wxFloatingPointValidator(int precision,
|
wxFloatingPointValidator(int precision,
|
||||||
ValueType *value = NULL,
|
ValueType *value = NULL,
|
||||||
int style = wxNUM_VAL_DEFAULT);
|
int style = wxNUM_VAL_DEFAULT);
|
||||||
//@}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
Reference in New Issue
Block a user