Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-22 22:24:56 +08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Replaced @returns with @return for more standard command use and compatibility.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53549 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-05-11 01:38:53 +00:00
parent a15c16bfd1
commit d29a9a8ac8
81 changed files with 383 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/wx/generic/progdlgg.h
+1 -1
View File
@@ -50,7 +50,7 @@ public:
/* Update the status bar to the new value.
@param value new value
@param newmsg if used, new message to display
@returns true if ABORT button has not been pressed
@return true if ABORT button has not been pressed
*/
virtual bool Update(int value, const wxString& newmsg = wxEmptyString, bool *skip = NULL);
interface/accel.h
+2 -2
View File
@@ -116,8 +116,8 @@ public:
@param str
Should be a string in the form "flags-keycode"
@returns @true if the given string correctly initialized this object
(i.e. if IsOk() returns true after this call)
@return @true if the given string correctly initialized this object
(i.e. if IsOk() returns true after this call)
*/
bool FromString(const wxString& str);
interface/access.h
+2 -3
View File
@@ -274,9 +274,8 @@ public:
@a childId is 0 (the action for this object) or greater than 0 (the action
for a child).
@returns
wxACC_NOT_SUPPORTED if there is no default action for this window
(e.g. an edit control).
@return wxACC_NOT_SUPPORTED if there is no default action for this
window (e.g. an edit control).
*/
virtual wxAccStatus DoDefaultAction(int childId);
interface/animate.h
+4 -4
View File
@@ -90,8 +90,8 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxAnimation& anim = wxNullAnimation,
@@ -246,7 +246,7 @@ public:
@li wxANIMATION_TYPE_ANI: load an ANI file;
@li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
*/
virtual bool Load(wxInputStream& stream,
wxAnimationType type = wxANIMATION_TYPE_ANY);
@@ -260,7 +260,7 @@ public:
One of the wxAnimationType values; wxANIMATION_TYPE_ANY
means that the function should try to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
*/
virtual bool LoadFile(const wxString& name,
wxAnimationType type = wxANIMATION_TYPE_ANY);
interface/app.h
+1 -2
View File
@@ -203,8 +203,7 @@ public:
Called by wxWidgets on creation of the application. Override this if you wish
to provide your own (environment-dependent) main loop.
@returns Returns 0 under X, and the wParam of the WM_QUIT message under
Windows.
@return 0 under X, and the wParam of the WM_QUIT message under Windows.
*/
virtual int MainLoop();
interface/artprov.h
+4 -4
View File
@@ -178,8 +178,8 @@ public:
@param size
Size of the returned bitmap or wxDefaultSize if size doesn't matter.
@returns The bitmap if one of registered providers recognizes the ID or
wxNullBitmap otherwise.
@return The bitmap if one of registered providers recognizes the ID or
wxNullBitmap otherwise.
*/
static wxBitmap GetBitmap(const wxArtID& id,
const wxArtClient& client = wxART_OTHER,
@@ -212,8 +212,8 @@ public:
wxArtClient identifier of the client (i.e. who is asking for the icon
bundle).
@returns The icon bundle if one of registered providers recognizes the ID
or wxNullIconBundle otherwise.
@return The icon bundle if one of registered providers recognizes the ID
or wxNullIconBundle otherwise.
*/
static wxIconBundle GetIconBundle(const wxArtID& id,
const wxArtClient& client = wxART_OTHER);
interface/base64.h
+1 -1
View File
@@ -33,7 +33,7 @@
@param srcLen
The length of the input data.
@returns @c wxCONV_FAILED if the output buffer is too small.
@return @c wxCONV_FAILED if the output buffer is too small.
@header{wx/base64.h}
*/
interface/bitmap.h
+10 -10
View File
@@ -64,7 +64,7 @@ public:
A bitmap type identifier - see ::wxBitmapType for a list
of possible values.
@returns @true if the call succeeded, @false otherwise (the default).
@return @true if the call succeeded, @false otherwise (the default).
*/
virtual bool Create(wxBitmap* bitmap, const void* data, wxBitmapType type,
int width, int height, int depth = 1);
@@ -100,7 +100,7 @@ public:
@param desiredHeight
The desired height for the loaded bitmap.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@see wxBitmap::LoadFile, wxBitmap::SaveFile, SaveFile()
*/
@@ -119,7 +119,7 @@ public:
@param palette
An optional palette used for saving the bitmap.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@see wxBitmap::LoadFile, wxBitmap::SaveFile, LoadFile()
*/
@@ -376,7 +376,7 @@ public:
@param depth
The depth of the bitmap in pixels. If this is -1, the screen depth is used.
@returns @true if the call succeeded, @false otherwise.
@return @true if the call succeeded, @false otherwise.
This overload depends on the @a type of data.
@@ -389,7 +389,7 @@ public:
/**
Finds the handler with the given @a name.
@returns A pointer to the handler if found, @NULL otherwise.
@return A pointer to the handler if found, @NULL otherwise.
*/
static wxBitmapHandler* FindHandler(const wxString& name);
@@ -401,7 +401,7 @@ public:
@param bitmapType
The bitmap type managed by the handler, see ::wxBitmapType.
@returns A pointer to the handler if found, @NULL otherwise.
@return A pointer to the handler if found, @NULL otherwise.
*/
static wxBitmapHandler* FindHandler(const wxString& extension,
wxBitmapType bitmapType);
@@ -412,7 +412,7 @@ public:
@param bitmapType
The bitmap type managed by the handler, see ::wxBitmapType.
@returns A pointer to the handler if found, @NULL otherwise.
@return A pointer to the handler if found, @NULL otherwise.
@see wxBitmapHandler
*/
@@ -503,7 +503,7 @@ public:
One of the ::wxBitmapType values; see the note in the class
detailed description.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@remarks A palette may be associated with the bitmap if one exists
(especially for colour Windows bitmaps), and if the
@@ -521,7 +521,7 @@ public:
@param name
The handler name.
@returns @true if the handler was found and removed, @false otherwise.
@return @true if the handler was found and removed, @false otherwise.
@see wxBitmapHandler
*/
@@ -538,7 +538,7 @@ public:
@param palette
An optional palette used for saving the bitmap.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@remarks Depending on how wxWidgets has been configured, not all formats
may be available.
interface/bmpbuttn.h
+4 -4
View File
@@ -131,7 +131,7 @@ public:
/**
Returns the bitmap for the disabled state, which may be invalid.
@returns A reference to the disabled state bitmap.
@return A reference to the disabled state bitmap.
@see SetBitmapDisabled()
*/
@@ -143,7 +143,7 @@ public:
/**
Returns the bitmap for the focused state, which may be invalid.
@returns A reference to the focused state bitmap.
@return A reference to the focused state bitmap.
@see SetBitmapFocus()
*/
@@ -165,7 +165,7 @@ public:
/**
Returns the label bitmap (the one passed to the constructor), always valid.
@returns A reference to the button's label bitmap.
@return A reference to the button's label bitmap.
@see SetBitmapLabel()
*/
@@ -176,7 +176,7 @@ public:
/**
Returns the bitmap for the selected state.
@returns A reference to the selected state bitmap.
@return A reference to the selected state bitmap.
@see SetBitmapSelected()
*/
interface/button.h
+1 -1
View File
@@ -131,7 +131,7 @@ public:
@remarks Under Windows, only dialog box buttons respond to this function.
@returns the old default item (possibly NULL)
@return the old default item (possibly NULL)
*/
virtual wxWindow* SetDefault();
interface/checkbox.h
+6 -6
View File
@@ -114,7 +114,7 @@ public:
/**
Gets the state of a 2-state checkbox.
@returns Returns @true if it is checked, @false otherwise.
@return Returns @true if it is checked, @false otherwise.
*/
bool GetValue() const;
@@ -127,8 +127,8 @@ public:
/**
Returns whether or not the checkbox is a 3-state checkbox.
@returns Returns @true if this checkbox is a 3-state checkbox, @false
if it's a 2-state checkbox.
@return @true if this checkbox is a 3-state checkbox, @false if it's
a 2-state checkbox.
*/
bool Is3State() const;
@@ -136,9 +136,9 @@ public:
Returns whether or not the user can set the checkbox to the third
state.
@returns Returns @true if the user can set the third state of this
checkbox, @false if it can only be set programmatically or if
it's a 2-state checkbox.
@return @true if the user can set the third state of this checkbox,
@false if it can only be set programmatically or if it's a
2-state checkbox.
*/
bool Is3rdStateAllowedForUser() const;
interface/clipbrd.h
+3 -3
View File
@@ -103,7 +103,7 @@ public:
(possibly eating memory), otherwise the clipboard will be emptied on
exit.
@returns @false if the operation is unsuccessful for any reason.
@return @false if the operation is unsuccessful for any reason.
*/
bool Flush();
@@ -142,8 +142,8 @@ public:
Call Close() when you have finished with the clipboard. You should keep
the clipboard open for only a very short time.
@returns @true on success. This should be tested (as in the sample
shown above).
@return @true on success. This should be tested (as in the sample
shown above).
*/
bool Open();
interface/clrpicker.h
+2 -2
View File
@@ -78,8 +78,8 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxColour& colour = wxBLACK,
interface/cmdproc.h
+8 -8
View File
@@ -52,10 +52,10 @@ public:
Override this member function to execute the appropriate action when
called.
@returns @true to indicate that the action has taken place, @false
otherwise. Returning @false will indicate to the command
processor that the action is not undoable and should not be
added to the command history.
@return @true to indicate that the action has taken place, @false
otherwise. Returning @false will indicate to the command
processor that the action is not undoable and should not be
added to the command history.
*/
bool Do();
@@ -81,10 +81,10 @@ public:
execute" operation is hard to write. The docview sample uses the
first method, to remove or restore segments in the drawing.
@returns @true to indicate that the action has taken place, @false
otherwise. Returning @false will indicate to the command
processor that the action is not redoable and no change should
be made to the command history.
@return @true to indicate that the action has taken place, @false
otherwise. Returning @false will indicate to the command
processor that the action is not redoable and no change should
be made to the command history.
*/
bool Undo();
};
interface/collpane.h
+2 -2
View File
@@ -136,8 +136,8 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxString& label,
interface/combo.h
+10 -10
View File
@@ -33,7 +33,7 @@ public:
/**
The derived class must implement this to create the popup control.
@returns @true if the call succeeded, @false otherwise.
@return @true if the call succeeded, @false otherwise.
*/
virtual bool Create(wxWindow* parent);
@@ -359,9 +359,9 @@ public:
The parameters are the same as those for DoShowPopup().
@returns @true if animation finishes before the function returns,
@false otherwise. In the latter case you need to manually call
DoShowPopup() after the animation ends.
@return @true if animation finishes before the function returns,
@false otherwise. In the latter case you need to manually call
DoShowPopup() after the animation ends.
*/
virtual bool AnimateShow(const wxRect& rect, int flags);
@@ -430,7 +430,7 @@ public:
Returns disabled button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the disabled state bitmap.
@return A reference to the disabled state bitmap.
*/
const wxBitmap GetBitmapDisabled() const;
@@ -438,7 +438,7 @@ public:
Returns button mouse hover bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the mouse hover state bitmap.
@return A reference to the mouse hover state bitmap.
*/
const wxBitmap GetBitmapHover() const;
@@ -446,7 +446,7 @@ public:
Returns default button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the normal state bitmap.
@return A reference to the normal state bitmap.
*/
const wxBitmap GetBitmapNormal() const;
@@ -454,7 +454,7 @@ public:
Returns depressed button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the depressed state bitmap.
@return A reference to the depressed state bitmap.
*/
const wxBitmap GetBitmapPressed() const;
@@ -475,8 +475,8 @@ public:
missing, you need to instead use wxGenericComboCtrl, which however may
lack a native look and feel (but otherwise sports identical API).
@returns Value returned is a combination of the flags defined in
wxComboCtrlFeatures.
@return Value returned is a combination of the flags defined in
wxComboCtrlFeatures.
*/
static int GetFeatures();
interface/config.h
+8 -8
View File
@@ -437,7 +437,7 @@ public:
//@{
/**
@returns @true if either a group or an entry with a given name exists.
@return @true if either a group or an entry with a given name exists.
*/
bool Exists(wxString& strName) const;
@@ -451,12 +451,12 @@ public:
wxConfigBase::EntryType GetEntryType(const wxString& name) const;
/**
@returns @true if the entry by this name exists.
@return @true if the entry by this name exists.
*/
bool HasEntry(wxString& strName) const;
/**
@returns @true if the group by this name exists.
@return @true if the group by this name exists.
*/
bool HasGroup(const wxString& strName) const;
@@ -503,7 +503,7 @@ public:
Read a string from the key. The default value is returned if the key
was not found.
@returns @true if value was really read, @false if the default was used.
@return @true if value was really read, @false if the default was used.
*/
const bool Read(const wxString& key, wxString* str,
const wxString& defaultVal) const;
@@ -637,8 +637,8 @@ public:
and the new one) shouldn't contain backslashes, i.e. only simple names
and not arbitrary paths are accepted by this function.
@returns @false if @a oldName doesn't exist or if @a newName already
exists.
@return @false if @a oldName doesn't exist or if @a newName already
exists.
*/
bool RenameEntry(const wxString& oldName, const wxString& newName);
@@ -647,8 +647,8 @@ public:
old and the new one) shouldn't contain backslashes, i.e. only simple
names and not arbitrary paths are accepted by this function.
@returns @false if @a oldName doesn't exist or if @a newName already
exists.
@return @false if @a oldName doesn't exist or if @a newName already
exists.
*/
bool RenameGroup(const wxString& oldName, const wxString& newName);
interface/cshelp.h
+2 -2
View File
@@ -107,8 +107,8 @@ public:
@param origin
Help event origin, see wxHelpEvent::GetOrigin.
@returns @true if help was shown, or @false if no help was available
for this window.
@return @true if help was shown, or @false if no help was available
for this window.
@since 2.7.0
*/
interface/ctrlsub.h
+27 -27
View File
@@ -56,8 +56,8 @@ public:
@param n
The zero-based index.
@returns The label of the item or an empty string if the position was
invalid.
@return The label of the item or an empty string if the position was
invalid.
*/
virtual wxString GetString(unsigned int n) const;
@@ -84,8 +84,8 @@ public:
@param caseSensitive
Whether search is case sensitive (default is not).
@returns The zero-based position of the item, or wxNOT_FOUND if the
string was not found.
@return The zero-based position of the item, or wxNOT_FOUND if the
string was not found.
*/
virtual int FindString(const wxString& s, bool bCase = false) const;
@@ -113,7 +113,7 @@ public:
Returns the index of the selected item or @c wxNOT_FOUND if no item is
selected.
@returns The position of the current selection.
@return The position of the current selection.
@remarks This method can be used with single selection list boxes only,
you should use wxListBox::GetSelections() for the list
@@ -130,8 +130,8 @@ public:
@param string
The string to select.
@returns @true if the specified string has been selected, @false if it
wasn't found in the control.
@return @true if the specified string has been selected, @false if it
wasn't found in the control.
*/
bool SetStringSelection(const wxString& string);
@@ -203,10 +203,10 @@ public:
@param item
String to add.
@returns The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
@return The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
*/
int Append(const wxString& item);
@@ -218,10 +218,10 @@ public:
@param clientData
Pointer to client data to associate with the new item.
@returns The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
@return The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
*/
int Append(const wxString& item, void* clientData);
@@ -233,10 +233,10 @@ public:
@param clientData
Pointer to client data to associate with the new item.
@returns The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
@return The return value is the index of the newly inserted item.
Note that this may be different from the last one if the
control is sorted (e.g. has @c wxLB_SORT or @c wxCB_SORT
style).
*/
int Append(const wxString& item, wxClientData* clientData);
@@ -361,7 +361,7 @@ public:
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
@return A pointer to the client data, or @NULL if not present.
*/
void* GetClientData(unsigned int n) const;
@@ -375,7 +375,7 @@ public:
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
@return A pointer to the client data, or @NULL if not present.
*/
wxClientData* GetClientObject(unsigned int n) const;
@@ -418,8 +418,8 @@ public:
@param pos
Position to insert item before, zero based.
@returns The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
@return The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
*/
int Insert(const wxString& item, unsigned int pos);
@@ -433,8 +433,8 @@ public:
@param clientData
Pointer to client data to associate with the new item.
@returns The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
@return The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
*/
int Insert(const wxString& item, unsigned int pos, void* clientData);
@@ -448,8 +448,8 @@ public:
@param clientData
Pointer to client data to associate with the new item.
@returns The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
@return The return value is the index of the newly inserted item.
If the insertion failed for some reason, -1 is returned.
*/
int Insert(const wxString& item, unsigned int pos,
wxClientData* clientData);
interface/dataobj.h
+1 -1
View File
@@ -587,7 +587,7 @@ public:
Set the data in the format @a format of the length @a len provided in
the buffer @a buf.
@returns @true on success, @false on failure.
@return @true on success, @false on failure.
*/
virtual bool SetData(const wxDataFormat& format, size_t len,
const void buf);
interface/datectrl.h
+2 -2
View File
@@ -89,7 +89,7 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
@@ -113,7 +113,7 @@ public:
@param dt2
Same as above but for the upper limit.
@returns @false if no range limits are currently set, @true if at least
@return @false if no range limits are currently set, @true if at least
one bound is set.
*/
bool GetRange(wxDateTime* dt1, wxDateTime dt2) const;
interface/datetime.h
+33 -33
View File
@@ -761,7 +761,7 @@ public:
be specified. It is thus less flexible then ParseDateTime(), but also
has less chances to misinterpret the user input.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseDate(const wxString& date,
@@ -771,7 +771,7 @@ public:
be specified. It is thus less flexible then ParseDateTime(), but also
has less chances to misinterpret the user input.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseDate(const char* date);
@@ -780,7 +780,7 @@ public:
be specified. It is thus less flexible then ParseDateTime(), but also
has less chances to misinterpret the user input.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const wchar_t* ParseDate(const wchar_t* date);
@@ -792,7 +792,7 @@ public:
anything that may be accepted and will only reject strings which can
not be parsed in any way at all.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseDateTime(const wxString& datetime,
@@ -804,7 +804,7 @@ public:
anything that may be accepted and will only reject strings which can
not be parsed in any way at all.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseDateTime(const char* datetime);
@@ -815,7 +815,7 @@ public:
anything that may be accepted and will only reject strings which can
not be parsed in any way at all.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const wchar_t* ParseDateTime(const wchar_t* datetime);
@@ -839,7 +839,7 @@ public:
@a dateDef. If it is not specified, Today() is used as the default
date.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseFormat(const wxString& date,
@@ -865,7 +865,7 @@ public:
@a dateDef. If it is not specified, Today() is used as the default
date.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseFormat(const char* date,
@@ -890,7 +890,7 @@ public:
@a dateDef. If it is not specified, Today() is used as the default
date.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const wchar_t* ParseFormat(const wchar_t* date,
@@ -903,7 +903,7 @@ public:
the date and time parts must be equal to @a sep for the function to
succeed.
@returns @true if the entire string was parsed successfully, @false
@return @true if the entire string was parsed successfully, @false
otherwise.
*/
bool ParseISOCombined(const wxString& date, char sep = 'T');
@@ -911,7 +911,7 @@ public:
/**
This function parses the date in ISO 8601 format @c "YYYY-MM-DD".
@returns @true if the entire string was parsed successfully, @false
@return @true if the entire string was parsed successfully, @false
otherwise.
*/
bool ParseISODate(const wxString& date);
@@ -919,7 +919,7 @@ public:
/**
This function parses the time in ISO 8601 format @c "HH:MM:SS".
@returns @true if the entire string was parsed successfully, @false
@return @true if the entire string was parsed successfully, @false
otherwise.
*/
bool ParseISOTime(const wxString& date);
@@ -987,7 +987,7 @@ public:
This functions is like ParseDateTime(), but only allows the time to be
specified in the input string.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseTime(const wxString& time,
@@ -996,7 +996,7 @@ public:
This functions is like ParseDateTime(), but only allows the time to be
specified in the input string.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const char* ParseTime(const char* time);
@@ -1004,7 +1004,7 @@ public:
This functions is like ParseDateTime(), but only allows the time to be
specified in the input string.
@returns @NULL if the conversion failed, otherwise return the pointer
@return @NULL if the conversion failed, otherwise return the pointer
to the character which stopped the scan.
*/
const wchar_t* ParseTime(const wchar_t* time);
@@ -1074,7 +1074,7 @@ public:
Sets the date to the last day in the specified month (the current one
by default).
@returns The reference to the modified object itself.
@return The reference to the modified object itself.
*/
wxDateTime SetToLastMonthDay(Month month = Inv_Month,
int year = Inv_Year);
@@ -1092,7 +1092,7 @@ public:
Sets the date so that it will be the first @a weekday following the
current date.
@returns The reference to the modified object itself.
@return The reference to the modified object itself.
*/
wxDateTime& SetToNextWeekDay(WeekDay weekday);
@@ -1100,7 +1100,7 @@ public:
Sets the date so that it will be the last @a weekday before the current
date.
@returns The reference to the modified object itself.
@return The reference to the modified object itself.
*/
wxDateTime& SetToPrevWeekDay(WeekDay weekday);
@@ -1115,7 +1115,7 @@ public:
SetToWeekDay(-1, wxDateTime::Sun) will set the date to the last Sunday
in the current month.
@returns @true if the date was modified successfully, @false otherwise
@return @true if the date was modified successfully, @false otherwise
meaning that the specified date doesn't exist.
*/
bool SetToWeekDay(WeekDay weekday, int n = 1,
@@ -1125,7 +1125,7 @@ public:
Adjusts the date so that it will still lie in the same week as before,
but its week day will be the given one.
@returns The reference to the modified object itself.
@return The reference to the modified object itself.
*/
wxDateTime SetToWeekDayInSameWeek(WeekDay weekday,
WeekFlags flags = Monday_First);
@@ -1136,7 +1136,7 @@ public:
number should be in the range 1-366 for the leap years and 1-365 for
the other ones.
@returns The reference to the modified object itself.
@return The reference to the modified object itself.
*/
wxDateTime& SetToYearDay(wxDateTime_t yday);
@@ -1209,7 +1209,7 @@ public:
Transform the date from the given time zone to the local one. If
@a noDST is @true, no DST adjustments will be made.
@returns The date in the local time zone.
@return The date in the local time zone.
*/
wxDateTime FromTimezone(const TimeZone& tz, bool noDST = false) const;
@@ -1240,7 +1240,7 @@ public:
Transform the date to the given time zone. If @a noDST is @true, no DST
adjustments will be made.
@returns The date in the new time zone.
@return The date in the new time zone.
*/
wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
@@ -1542,7 +1542,7 @@ public:
/**
Returns the sum of two date spans.
@returns A new wxDateSpan object with the result.
@return A new wxDateSpan object with the result.
*/
wxDateSpan Add(const wxDateSpan& other) const;
/**
@@ -1618,14 +1618,14 @@ public:
product is computed by multiplying each of the components by the
@a factor.
@returns A new wxDateSpan object with the result.
@return A new wxDateSpan object with the result.
*/
wxDateSpan Multiply(int factor) const;
/**
Multiplies this date span by the specified @a factor. The product is
computed by multiplying each of the components by the @a factor.
@returns A reference to this wxDateSpan object modified in place.
@return A reference to this wxDateSpan object modified in place.
*/
wxDateSpan& Multiply(int factor);
@@ -1670,7 +1670,7 @@ public:
/**
Returns the difference of two date spans.
@returns A new wxDateSpan object with the result.
@return A new wxDateSpan object with the result.
*/
wxDateSpan Subtract(const wxDateSpan& other) const;
/**
@@ -1729,7 +1729,7 @@ public:
Multiplies this date span by the specified @a factor. The product is
computed by multiplying each of the components by the @a factor.
@returns A reference to this wxDateSpan object modified in place.
@return A reference to this wxDateSpan object modified in place.
*/
wxDateSpan& operator*=(int factor);
@@ -1782,7 +1782,7 @@ public:
/**
Returns the sum of two time spans.
@returns A new wxDateSpan object with the result.
@return A new wxDateSpan object with the result.
*/
wxTimeSpan Add(const wxTimeSpan& diff) const;
/**
@@ -1931,13 +1931,13 @@ public:
/**
Returns the product of this time span by @a n.
@returns A new wxTimeSpan object with the result.
@return A new wxTimeSpan object with the result.
*/
wxTimeSpan Multiply(int n) const;
/**
Multiplies this time span by @a n.
@returns A reference to this wxTimeSpan object modified in place.
@return A reference to this wxTimeSpan object modified in place.
*/
wxTimeSpan& Multiply(int n);
@@ -1968,7 +1968,7 @@ public:
/**
Returns the difference of two time spans.
@returns A new wxDateSpan object with the result.
@return A new wxDateSpan object with the result.
*/
wxTimeSpan Subtract(const wxTimeSpan& diff) const;
/**
@@ -1995,7 +1995,7 @@ public:
/**
Multiplies this time span by @a n.
@returns A reference to this wxTimeSpan object modified in place.
@return A reference to this wxTimeSpan object modified in place.
*/
wxTimeSpan& operator*=(int n);
interface/dc.h
+2 -2
View File
@@ -468,7 +468,7 @@ public:
- wxFLOOD_BORDER: The area to be flooded is bounded by the given
colour.
@returns @false if the operation failed.
@return @false if the operation failed.
@note The present implementation for non-Windows platforms may fail to
find colour borders if the pixels do not match the colour
@@ -581,7 +581,7 @@ public:
@a string is the text string to measure, @e heightLine, if non @NULL,
is where to store the height of a single line.
@returns The text extent as a wxSize object.
@return The text extent as a wxSize object.
@note This function works with both single-line and multi-line strings.
interface/dde.h
+7 -7
View File
@@ -68,7 +68,7 @@ public:
the data associated with the given item. Causes the client connection's
OnAdvise() member to be called.
@returns @true if successful.
@return @true if successful.
*/
bool Advise(const wxString& item, const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
@@ -85,7 +85,7 @@ public:
calling application must explicitly delete its side of the connection
having called Disconnect().
@returns @true if successful.
@return @true if successful.
*/
bool Disconnect();
@@ -96,7 +96,7 @@ public:
Poke() in that respect). Causes the server connection's OnExecute()
member to be called.
@returns @true if successful.
@return @true if successful.
*/
bool Execute(const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
@@ -164,7 +164,7 @@ public:
used to transfer arbitrary data to the server. Causes the server
connection's OnPoke() member to be called.
@returns @true if successful.
@return @true if successful.
*/
bool Poke(const wxString& item, const void* data, size_t size,
wxIPCFormat format = wxIPC_PRIVATE);
@@ -177,7 +177,7 @@ public:
Called by the client application to request data from the server.
Causes the server connection's OnRequest() member to be called.
@returns A character string (actually a pointer to the connection's
@return A character string (actually a pointer to the connection's
buffer) if successful, @NULL otherwise.
*/
const void* Request(const wxString& item, size_t* size,
@@ -188,7 +188,7 @@ public:
started with the server. Causes the server connection's OnStartAdvise()
member to be called.
@returns @true if the server okays it, @false otherwise.
@return @true if the server okays it, @false otherwise.
*/
bool StartAdvise(const wxString& item);
@@ -197,7 +197,7 @@ public:
stopped. Causes the server connection's OnStopAdvise() member to be
called.
@returns @true if the server okays it, @false otherwise.
@return @true if the server okays it, @false otherwise.
*/
bool StopAdvise(const wxString& item);
};
interface/debugrpt.h
+3 -3
View File
@@ -41,7 +41,7 @@ public:
Present the report to the user and allow him to modify it by removing
some or all of the files and, potentially, adding some notes.
@returns @true if the report should be processed or @false if the user
@return @true if the report should be processed or @false if the user
chose to cancel report generation or removed all files from
it.
*/
@@ -198,7 +198,7 @@ public:
the given @a name and writes @a text to it, then adds the file to the
report. The @a filename shouldn't contain the path.
@returns @true if file could be added successfully, @false if an IO
@return @true if file could be added successfully, @false if an IO
error occurred.
*/
bool AddText(const wxString& filename, const wxString& text,
@@ -232,7 +232,7 @@ public:
This method should be used to construct the full name of the files
which you wish to add to the report using AddFile().
@returns The name of the temporary directory used for the files in this
@return The name of the temporary directory used for the files in this
report.
*/
const wxString GetDirectory() const;
interface/dialog.h
+1 -1
View File
@@ -556,7 +556,7 @@ public:
Shows a modal dialog. Program flow does not return until the dialog has
been dismissed with EndModal().
@returns The value set with SetReturnCode().
@return The value set with SetReturnCode().
@see EndModal(), GetReturnCode(), SetReturnCode()
*/
interface/dialup.h
+1 -1
View File
@@ -101,7 +101,7 @@ public:
by the system and so we don't do any polling and this parameter is
ignored.
@returns @false if couldn't set up automatic check for online status.
@return @false if couldn't set up automatic check for online status.
*/
bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60);
interface/dnd.h
+6 -6
View File
@@ -121,7 +121,7 @@ public:
Suggested value for return value. Determined by SHIFT or CONTROL
key states.
@returns The desired operation or wxDragNone. This is used for optical
@return The desired operation or wxDragNone. This is used for optical
feedback from the side of the drop source, typically in form
of changing the icon.
*/
@@ -136,7 +136,7 @@ public:
@param y
The y coordinate of the mouse.
@returns @true to accept the data, or @false to veto the operation.
@return @true to accept the data, or @false to veto the operation.
*/
virtual bool OnDrop(wxCoord x, wxCoord y);
@@ -152,7 +152,7 @@ public:
Suggested default for return value. Determined by SHIFT or CONTROL
key states.
@returns The desired operation or wxDragNone. This is used for optical
@return The desired operation or wxDragNone. This is used for optical
feedback from the side of the drop source, typically in form
of changing the icon.
*/
@@ -244,7 +244,7 @@ public:
(which includes the previous flag), this is even the default
operation.
@returns The operation requested by the user, may be ::wxDragCopy,
@return The operation requested by the user, may be ::wxDragCopy,
::wxDragMove, ::wxDragLink, ::wxDragCancel or ::wxDragNone if
an error occurred.
*/
@@ -266,7 +266,7 @@ public:
@param scrolling
@true if the window is scrolling. MSW only.
@returns @false if you want default feedback, or @true if you implement
@return @false if you want default feedback, or @true if you implement
your own feedback. The return values is ignored under GTK.
*/
virtual bool GiveFeedback(wxDragResult effect);
@@ -349,7 +349,7 @@ public:
This macro should be used with wxDropSource::wxDropSource().
@returns wxCursor on MSW, otherwise returns a wxIcon
@return wxCursor on MSW, otherwise returns a wxIcon
@header{wx/dnd.h}
*/
interface/dynlib.h
+1 -1
View File
@@ -32,7 +32,7 @@ public:
Pointer to the location to return the size of this module in
memory in, may be @NULL.
@returns @true if the load address and module size were retrieved,
@return @true if the load address and module size were retrieved,
@false if this information is not available.
*/
bool GetAddress(void** addr, size_t len) const;
interface/event.h
+3 -3
View File
@@ -528,7 +528,7 @@ public:
@param event
Event to process.
@returns @true if a suitable event handler function was found and
@return @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@see SearchEventTable()
@@ -543,7 +543,7 @@ public:
@param event
Event to process.
@returns @true if the event was processed, @false if no handler was found
@return @true if the event was processed, @false if no handler was found
or an exception was thrown.
@see wxWindow::HandleWindowEvent
@@ -559,7 +559,7 @@ public:
@param event
Event to be matched against an event table entry.
@returns @true if a suitable event handler function was found and
@return @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@remarks This function looks through the object's event table and tries
interface/ffile.h
+3 -3
View File
@@ -177,7 +177,7 @@ public:
@param count
The number of bytes to read.
@returns The number of bytes read.
@return The number of bytes read.
*/
size_t Read(void* buffer, size_t count);
@@ -190,7 +190,7 @@ public:
Conversion object to use in Unicode build; by default supposes
that file contents is encoded in UTF-8.
@returns @true if file was read successfully, @false otherwise.
@return @true if file was read successfully, @false otherwise.
*/
bool ReadAll(wxString* str, const wxMBConv& conv = wxConvAuto());
@@ -234,7 +234,7 @@ public:
@param count
The number of bytes to write.
@returns The number of bytes written.
@return The number of bytes written.
*/
size_t Write(const void* buffer, size_t count);
interface/file.h
+2 -2
View File
@@ -281,7 +281,7 @@ public:
@param mode
One of wxFromStart, wxFromEnd, wxFromCurrent.
@returns The actual offset position achieved, or wxInvalidOffset on
@return The actual offset position achieved, or wxInvalidOffset on
failure.
*/
wxFileOffset Seek(wxFileOffset ofs,
@@ -295,7 +295,7 @@ public:
@param ofs
Number of bytes before the end of the file.
@returns The actual offset position achieved, or wxInvalidOffset on
@return The actual offset position achieved, or wxInvalidOffset on
failure.
*/
wxFileOffset SeekEnd(wxFileOffset ofs = 0);
interface/filectrl.h
+3 -3
View File
@@ -78,7 +78,7 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
@return @true if the control was successfully created or @false if
creation failed.
*/
@@ -154,14 +154,14 @@ public:
/**
Sets(changes) the current directory displayed in the control.
@returns Returns @true on success, @false otherwise.
@return Returns @true on success, @false otherwise.
*/
bool SetDirectory(const wxString& directory);
/**
Selects a certain file.
@returns Returns @true on success, @false otherwise
@return Returns @true on success, @false otherwise
*/
bool SetFilename(const wxString& filename);
interface/filefn.h
+1 -1
View File
@@ -124,7 +124,7 @@ public:
@note The generic Unix implementation depends on the system having the
@c statfs() or @c statvfs() function.
@returns @true on success, @false if an error occurred (for example, the
@return @true on success, @false if an error occurred (for example, the
directory doesn’t exist).
@header{wx/filefn.h}
interface/filename.h
+6 -6
View File
@@ -178,7 +178,7 @@ public:
@param fileTemp
The file to open or @NULL to just get the name
@returns The full temporary file name or an empty string on error.
@return The full temporary file name or an empty string on error.
*/
static wxString CreateTempFileName(const wxString& prefix,
wxFile* fileTemp = NULL);
@@ -333,7 +333,7 @@ public:
the volume is empty, the program's current working directory is returned for the
current volume.
@returns The string containing the current working directory or an empty
@return The string containing the current working directory or an empty
string on error.
@see AssignCwd()
@@ -511,7 +511,7 @@ public:
Any of the pointers may be @NULL if the corresponding time is not
needed.
@returns @true on success, @false if we failed to retrieve the times.
@return @true on success, @false if we failed to retrieve the times.
*/
bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod,
wxDateTime* dtCreate) const;
@@ -681,7 +681,7 @@ public:
@param format
the file name format, native by default
@returns @true if the file name has been changed, @false if we failed to do
@return @true if the file name has been changed, @false if we failed to do
anything with it (currently this only happens if the
file name is on a volume different from the volume
specified by pathBase).
@@ -702,7 +702,7 @@ public:
try to create each directory in the path and also don't return an error
if the target directory already exists.
@returns Returns @true if the directory was successfully created, @false
@return Returns @true if the directory was successfully created, @false
otherwise.
*/
bool Mkdir(int perm = 0777, int flags = 0);
@@ -814,7 +814,7 @@ public:
@param format
The file name format to use when processing the paths, native by default.
@returns @true if normalization was successfully or @false otherwise.
@return @true if normalization was successfully or @false otherwise.
*/
bool Normalize(int flags = wxPATH_NORM_ALL,
const wxString& cwd = wxEmptyString,
interface/filepicker.h
+2 -2
View File
@@ -88,7 +88,7 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
@@ -202,7 +202,7 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
interface/fontpicker.h
+1 -1
View File
@@ -76,7 +76,7 @@ public:
@param name
Control name.
@returns @true if the control was successfully created or @false if
@return @true if the control was successfully created or @false if
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
interface/frame.h
+4 -4
View File
@@ -196,7 +196,7 @@ public:
@param name
The status bar window name.
@returns A pointer to the status bar if it was created successfully, @NULL
@return A pointer to the status bar if it was created successfully, @NULL
otherwise.
@remarks The width of the status bar is the whole width of the frame
@@ -222,7 +222,7 @@ public:
@param name
The toolbar window name.
@returns A pointer to the toolbar if it was created successfully, @NULL
@return A pointer to the toolbar if it was created successfully, @NULL
otherwise.
@remarks By default, the toolbar is an instance of wxToolBar (which is
@@ -286,7 +286,7 @@ public:
@param name
The window name.
@returns A status bar object.
@return A status bar object.
@remarks An application can override this function to return a different
kind of status bar. The default implementation returns
@@ -310,7 +310,7 @@ public:
@param name
The toolbar window name.
@returns A toolbar object.
@return A toolbar object.
@remarks An application can override this function to return a different
kind of toolbar. The default implementation returns an
interface/gbsizer.h
+1 -1
View File
@@ -86,7 +86,7 @@ public:
/**
Adds the given item to the given position.
@returns A valid pointer if the item was successfully placed at the
@return A valid pointer if the item was successfully placed at the
given position, or @NULL if something was already there.
*/
wxSizerItem* Add(wxWindow* window, const wxGBPosition& pos,
interface/gdicmn.h
+1 -1
View File
@@ -723,7 +723,7 @@ public:
to scale both dimensions by the same factor you can also use
operator*=().
@returns A reference to this object (so that you can concatenate other
@return A reference to this object (so that you can concatenate other
operations in the same line).
*/
wxSize& Scale(float xscale, float yscale);
interface/html/htmlcell.h
+1 -1
View File
@@ -277,7 +277,7 @@ public:
@param event
mouse event that triggered the call
@returns @true if a link was clicked, @false otherwise.
@return @true if a link was clicked, @false otherwise.
*/
virtual bool ProcessMouseClick(wxHtmlWindowInterface* window,
const wxPoint& pos,
interface/html/htmlpars.h
+1 -1
View File
@@ -35,7 +35,7 @@ public:
one of supported tags is detected. @a tag contains all necessary
info (see wxHtmlTag for details).
@returns @true if ParseInner was called, @false otherwise.
@return @true if ParseInner was called, @false otherwise.
*/
virtual bool HandleTag(const wxHtmlTag& tag);
interface/html/htmlwin.h
+5 -5
View File
@@ -72,7 +72,7 @@ public:
@param source
HTML code fragment
@returns @false if an error occurred, @true otherwise.
@return @false if an error occurred, @true otherwise.
*/
bool AppendToPage(const wxString& source);
@@ -140,7 +140,7 @@ public:
/**
Loads HTML page from file and displays it.
@returns @false if an error occurred, @true otherwise
@return @false if an error occurred, @true otherwise
@see LoadPage()
*/
@@ -154,7 +154,7 @@ public:
The address of document. See wxFileSystem for details on address format and
behaviour of "opener".
@returns @false if an error occurred, @true otherwise
@return @false if an error occurred, @true otherwise
@see LoadFile()
*/
@@ -176,7 +176,7 @@ public:
@param event
The mouse event containing other information about the click
@returns @true if a link was clicked, @false otherwise.
@return @true if a link was clicked, @false otherwise.
*/
virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y,
const wxMouseEvent& event);
@@ -351,7 +351,7 @@ public:
@param source
The HTML document source to be displayed.
@returns @false if an error occurred, @true otherwise.
@return @false if an error occurred, @true otherwise.
*/
bool SetPage(const wxString& source);
interface/icon.h
+1 -1
View File
@@ -274,7 +274,7 @@ public:
The validity of these flags depends on the platform and wxWidgets
configuration.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@see wxIcon()
*/
interface/image.h
+17 -15
View File
@@ -25,6 +25,8 @@
@category{FIXME}
@see wxImage, wxInitAllImageHandlers()
@todo Document all image handler types, indicating their library.
*/
class wxImageHandler : public wxObject
{
@@ -54,7 +56,7 @@ public:
Opened input stream for reading image data. Currently, the stream must
support seeking.
@returns Number of available images. For most image handlers, this is 1
@return Number of available images. For most image handlers, this is 1
(exceptions are TIFF and ICO formats).
*/
int GetImageCount(wxInputStream& stream);
@@ -91,7 +93,7 @@ public:
@param index
The index of the image in the file (starting from zero).
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@see wxImage::LoadFile, wxImage::SaveFile, SaveFile()
*/
@@ -106,7 +108,7 @@ public:
@param stream
Opened output stream for writing the data.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@see wxImage::LoadFile, wxImage::SaveFile, LoadFile()
*/
@@ -359,7 +361,7 @@ public:
wxImageHistogram object. wxImageHistogram is a specialization of
wxHashMap "template" and is defined as follows:
@returns Returns number of colours in the histogram.
@return Returns number of colours in the histogram.
*/
unsigned long ComputeHistogram(wxImageHistogram& histogram) const;
@@ -371,7 +373,7 @@ public:
If the image image doesn't have alpha channel,
ConvertAlphaToMask does nothing.
@returns @false if FindFirstUnusedColour returns @false, @true otherwise.
@return @false if FindFirstUnusedColour returns @false, @true otherwise.
*/
bool ConvertAlphaToMask(unsigned char threshold = 128);
@@ -413,7 +415,7 @@ public:
@param height
The height of the image in pixels.
@returns @true if the call succeeded, @false otherwise.
@return @true if the call succeeded, @false otherwise.
*/
bool Create(int width, int height, bool clear = true);
@@ -429,7 +431,7 @@ public:
Initial values of the colour. Returned colour
will have RGB values equal to or greater than these.
@returns Returns @false if there is no unused colour left, @true on success.
@return Returns @false if there is no unused colour left, @true on success.
*/
bool FindFirstUnusedColour(unsigned char* r, unsigned char* g,
unsigned char* b,
@@ -450,7 +452,7 @@ public:
@param mimetype
MIME type.
@returns A pointer to the handler if found, @NULL otherwise.
@return A pointer to the handler if found, @NULL otherwise.
@see wxImageHandler
*/
@@ -536,7 +538,7 @@ public:
@li wxBITMAP_TYPE_ANI: Load a Windows animated cursor file (ANI).
@li wxBITMAP_TYPE_ANY: Will try to autodetect the format.
@returns Number of available images. For most image handlers, this is 1
@return Number of available images. For most image handlers, this is 1
(exceptions are TIFF and ICO formats).
*/
static int GetImageCount(const wxString& filename,
@@ -550,7 +552,7 @@ public:
file extension masks
suitable for passing to file open/save dialog boxes.
@returns The format of the returned string is
@return The format of the returned string is
"(*.ext1;*.ext2)|*.ext1;*.ext2".
@see wxImageHandler
@@ -739,7 +741,7 @@ public:
interpreted as the first image (index=0) by the GIF and TIFF handler
and as the largest and most colourful one by the ICO handler.
@returns @true if the operation succeeded, @false otherwise. If the
@return @true if the operation succeeded, @false otherwise. If the
optional index parameter is out of range, @false is
returned and a call to wxLogError() takes place.
@@ -793,7 +795,7 @@ public:
@param name
The handler name.
@returns @true if the handler was found and removed, @false otherwise.
@return @true if the handler was found and removed, @false otherwise.
@see wxImageHandler
*/
@@ -884,7 +886,7 @@ public:
@param mimetype
MIME type.
@returns @true if the operation succeeded, @false otherwise.
@return @true if the operation succeeded, @false otherwise.
@remarks Depending on how wxWidgets has been configured, not all formats
may be available.
@@ -980,7 +982,7 @@ public:
@param mr,mg,mb
RGB value of pixels in mask that will be used to create the mask.
@returns Returns @false if mask does not have same dimensions as the image
@return Returns @false if mask does not have same dimensions as the image
or if there is no unused colour left. Returns @true if
the mask was successfully applied.
*/
@@ -1039,7 +1041,7 @@ public:
@param image
Image to assign.
@returns Returns 'this' object.
@return Returns 'this' object.
*/
wxImage operator =(const wxImage& image);
};
interface/imaglist.h
+3 -3
View File
@@ -60,7 +60,7 @@ public:
@param icon
Icon to use as the image.
@returns The new zero-based image index.
@return The new zero-based image index.
@remarks The original bitmap or icon is not affected by the Add
operation, and can be deleted afterwards.
@@ -169,7 +169,7 @@ public:
@param height
receives the height of the images in the list
@returns @true if the function succeeded, @false if it failed (for example,
@return @true if the function succeeded, @false if it failed (for example,
if the image list was not yet initialized).
*/
bool GetSize(int index, int& width, int& height) const;
@@ -195,7 +195,7 @@ public:
@param icon
Icon to use as the image.
@returns @true if the replacement was successful, @false otherwise.
@return @true if the replacement was successful, @false otherwise.
@remarks The original bitmap or icon is not affected by the Replace
operation, and can be deleted afterwards.
interface/intl.h
+2 -2
View File
@@ -544,7 +544,7 @@ public:
This macro is identical to _() but for the plural variant of
wxGetTranslation().
@returns A const wxString.
@return A const wxString.
@header{wx/intl.h}
*/
@@ -587,7 +587,7 @@ public:
would be no translations for the weekday names in the program message
catalog and wxGetTranslation() wouldn't find them.
@returns A const wxChar*.
@return A const wxChar*.
@header{wx/intl.h}
*/
interface/joystick.h
+2 -2
View File
@@ -240,7 +240,7 @@ public:
/**
Releases the capture set by @b SetCapture.
@returns @true if the capture release succeeded.
@return @true if the capture release succeeded.
@see SetCapture(), wxJoystickEvent
*/
@@ -256,7 +256,7 @@ public:
threshold. If greater than zero, events are received every pollingFreq
milliseconds.
@returns @true if the capture succeeded.
@return @true if the capture succeeded.
@see ReleaseCapture(), wxJoystickEvent
*/
interface/listbox.h
+3 -3
View File
@@ -150,7 +150,7 @@ public:
A reference to an wxArrayInt instance that is used to store the result of
the query.
@returns The number of selections.
@return The number of selections.
@remarks Use this with a multiple selection listbox.
@@ -168,7 +168,7 @@ public:
@param point
Point of item (in client coordinates) to obtain
@returns Item located at point, or wxNOT_FOUND if unimplemented or the
@return Item located at point, or wxNOT_FOUND if unimplemented or the
item does not exist.
@since 2.7.0
@@ -200,7 +200,7 @@ public:
@param n
The zero-based item index.
@returns @true if the given item is selected, @false otherwise.
@return @true if the given item is selected, @false otherwise.
*/
bool IsSelected(int n) const;
interface/listctrl.h
+2 -2
View File
@@ -1149,7 +1149,7 @@ public:
Together with GetNextSelected() it can be
used to iterate over all selected items in the control.
@returns The first selected item, if any, -1 otherwise.
@return The first selected item, if any, -1 otherwise.
*/
long GetFirstSelected() const;
@@ -1164,7 +1164,7 @@ public:
Used together with GetFirstSelected() to
iterate over all selected items in the control.
@returns Returns the next selected item or -1 if there are no more of
@return Returns the next selected item or -1 if there are no more of
them.
*/
long GetNextSelected(long item) const;

Some files were not shown because too many files have changed in this diff Show More