Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some spelling/grammar errors in documentation

Browse Source 
Mostly replace ungrammatical "allows to do" with correct "allows doing".

Closes https://github.com/wxWidgets/wxWidgets/pull/1183
This commit is contained in:
Scott Talbert
2019-01-25 21:14:20 -05:00
committed by Vadim Zeitlin
parent 84fc5c1714
commit c68e5d0617
67 changed files with 106 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/wx/bmpbuttn.h
View File

@@ -12,7 +12,7 @@
Notice that since wxWidgets 2.9.1 bitmap display is supported by the base
wxButton class itself and the only tiny advantage of using this class is
that it allows to specify the bitmap in its constructor, unlike wxButton.
that it allows specifying the bitmap in its constructor, unlike wxButton.
Please see the base class documentation for more information about images
support in wxButton.

2
interface/wx/busyinfo.h
View File

@@ -88,7 +88,7 @@ public:
/**
General constructor.
This constructor allows to specify all supported attributes by calling
This constructor allows specifying all supported attributes by calling
the appropriate methods on wxBusyInfoFlags object passed to it as
parameter. All of them are optional but usually at least the message
should be specified.

2
interface/wx/button.h
View File

@@ -180,7 +180,7 @@ public:
/**
Returns the default size for the buttons. It is advised to make all the dialog
buttons of the same size and this function allows to retrieve the (platform and
buttons of the same size and this function allows retrieving the (platform and
current font dependent size) which should be the best suited for this.
*/
static wxSize GetDefaultSize();

2
interface/wx/calctrl.h
View File

@@ -244,7 +244,7 @@ enum wxCalendarHitTestResult
An item without custom attributes is drawn with the default colours and
font and without border, but setting custom attributes with SetAttr()
allows to modify its appearance. Just create a custom attribute object and
allows modifying its appearance. Just create a custom attribute object and
set it for the day you want to be displayed specially (note that the
control will take ownership of the pointer, i.e. it will delete it itself).
A day may be marked as being a holiday, even if it is not recognized as

2
interface/wx/clipbrd.h
View File

@@ -165,7 +165,7 @@ public:
until this function is called again with @false.
On the other platforms, there is no PRIMARY selection and so all
clipboard operations will fail. This allows to implement the standard
clipboard operations will fail. This allows implementing the standard
X11 handling of the clipboard which consists in copying data to the
CLIPBOARD selection only when the user explicitly requests it (i.e. by
selecting the "Copy" menu command) but putting the currently selected

2
interface/wx/clrpicker.h
View File

@@ -35,7 +35,7 @@ wxEventType wxEVT_COLOURPICKER_CHANGED;
Shows the colour in HTML form (AABBCC) as colour button label
(instead of no label at all).
@style{wxCLRP_SHOW_ALPHA}
Allows to select opacity in the colour-chooser (effective under
Allows selecting opacity in the colour-chooser (effective under
wxGTK and wxOSX).
@endStyleTable

4
interface/wx/cmdline.h
View File

@@ -596,8 +596,8 @@ public:
/**
Enable or disable support for the long options.
As long options are not (yet) POSIX-compliant, this option allows to
disable them.
As long options are not (yet) POSIX-compliant, this option allows
disabling them.
@see @ref cmdlineparser_customization and AreLongOptionsEnabled()
*/

2
interface/wx/collpane.h
View File

@@ -87,7 +87,7 @@ wxEventType wxEVT_COLLAPSIBLEPANE_CHANGED;
The default style. It includes wxTAB_TRAVERSAL and wxBORDER_NONE.
@style{wxCP_NO_TLW_RESIZE}
By default wxCollapsiblePane resizes the top level window containing it
when its own size changes. This allows to easily implement dialogs
when its own size changes. This allows easily implementing dialogs
containing an optionally shown part, for example, and so is the default
behaviour but can be inconvenient in some specific cases -- use this
flag to disable this automatic parent resizing then.

2
interface/wx/dataview.h
View File

@@ -1634,7 +1634,7 @@ public:
/**
Set custom colours and/or font to use for the header.
This method allows to customize the display of the control header (it
This method allows customizing the display of the control header (it
does nothing if @c wxDV_NO_HEADER style is used).
Currently it is only implemented in the generic version and just

4
interface/wx/datetime.h
View File

@@ -164,7 +164,7 @@ public:
};
/**
Date calculations often depend on the country and wxDateTime allows to set
Date calculations often depend on the country and wxDateTime allows setting
the country whose conventions should be used using SetCountry(). It takes
one of the following values as parameter.
*/
@@ -795,7 +795,7 @@ public:
/**
Returns the difference between this object and @a dt as a wxDateSpan.
This method allows to find the number of entire years, months, weeks and
This method allows finding the number of entire years, months, weeks and
days between @a dt and this date.
@since 2.9.5

6
interface/wx/dc.h
View File

@@ -146,7 +146,7 @@ struct wxFontMetrics
stated. Logical units are arbitrary units mapped to device units using
the current mapping mode (see wxDC::SetMapMode).
This mechanism allows to reuse the same code which prints on e.g. a window
This mechanism allows reusing the same code which prints on e.g. a window
on the screen to print on e.g. a paper.
@@ -853,7 +853,7 @@ public:
/**
Returns the various font characteristics.
This method allows to retrieve some of the font characteristics not
This method allows retrieving some of the font characteristics not
returned by GetTextExtent(), notably internal leading and average
character width.
@@ -1213,7 +1213,7 @@ public:
/**
Copy from a source DC to this DC possibly changing the scale.
Unlike Blit(), this method allows to specify different source and
Unlike Blit(), this method allows specifying different source and
destination region sizes, meaning that it can stretch or shrink it
while copying. The same can be achieved by changing the scale of the
source or target DC but calling this method is simpler and can also be

6
interface/wx/debugrpt.h
View File

@@ -74,7 +74,7 @@ public:
way (e.g. automatically uploaded to a remote server) but if the user is
asked to manually upload or send the report, it may be more convenient
to generate it in e.g. the users home directory and this function
allows to do this.
allows doing this.
Notice that it should be called before wxDebugReport::Process() or it
has no effect.
@@ -90,8 +90,8 @@ public:
/**
Set the base name of the generated debug report file.
This function is similar to SetCompressedFileDirectory() but allows to
change the base name of the file. Notice that the file extension will
This function is similar to SetCompressedFileDirectory() but allows
changing the base name of the file. Notice that the file extension will
always be @c .zip.
By default, a unique name constructed from wxApp::GetAppName(), the

2
interface/wx/defs.h
View File

@@ -292,7 +292,7 @@ enum wxBorder
/* wxCommandEvents and the objects of the derived classes are forwarded to the */
/* parent window and so on recursively by default. Using this flag for the */
/* given window allows to block this propagation at this window, i.e. prevent */
/* given window allows blocking this propagation at this window, i.e. preventing */
/* the events from being propagated further upwards. The dialogs have this */
/* flag on by default. */
#define wxWS_EX_BLOCK_EVENTS 0x00000002

2
interface/wx/dialog.h
View File

@@ -590,7 +590,7 @@ public:
EndModal().
Notice that it is possible to call ShowModal() for a dialog which had
been previously shown with Show(), this allows to make an existing
been previously shown with Show(), this allows making an existing
modeless dialog modal. However ShowModal() can't be called twice
without intervening EndModal() calls.

2
interface/wx/dialup.h
View File

@@ -162,7 +162,7 @@ public:
/**
Sometimes the built-in logic for determining the online status may
fail, so, in general, the user should be allowed to override it. This
function allows to forcefully set the online status - whatever our
function allows forcefully setting the online status - whatever our
internal algorithm may think about it.
@see IsOnline()

2
interface/wx/dir.h
View File

@@ -137,7 +137,7 @@ enum wxDirFlags
@class wxDir
wxDir is a portable equivalent of Unix open/read/closedir functions which
allow enumerating of the files in a directory. wxDir allows to enumerate
allow enumerating of the files in a directory. wxDir allows enumerating
files as well as directories.
wxDir also provides a flexible way to enumerate files recursively using

10
interface/wx/event.h
View File

@@ -279,7 +279,7 @@ protected:
/**
@class wxEventBlocker
This class is a special event handler which allows to discard
This class is a special event handler which allows discarding
any event (or a set of event types) directed to a specific window.
Example:
@@ -713,7 +713,7 @@ public:
usage, it has no advantages compared to Bind().
This is an alternative to the use of static event tables. It is more
flexible as it allows to connect events generated by some object to an
flexible as it allows connecting events generated by some object to an
event handler defined in a different object of a different class (which
is impossible to do directly with the event tables -- the events can be
only handled in another object if they are propagated upwards to it).
@@ -2477,8 +2477,8 @@ public:
@c wxEVT_TEXT_CUT and @c wxEVT_TEXT_PASTE.
If any of these events is processed (without being skipped) by an event
handler, the corresponding operation doesn't take place which allows to
prevent the text from being copied from or pasted to a control. It is also
handler, the corresponding operation doesn't take place which allows
preventing the text from being copied from or pasted to a control. It is also
possible to examine the clipboard contents in the PASTE event handler and
transform it in some way before inserting in a control -- for example,
changing its case or removing invalid characters.
@@ -3023,7 +3023,7 @@ public:
bool GetActive() const;
/**
Allows to check if the window was activated by clicking it with the
Allows checking if the window was activated by clicking it with the
mouse or in some other way.
This method is currently only implemented in wxMSW and returns @c

12
interface/wx/eventfilter.h
View File

@@ -13,8 +13,8 @@
This is a very simple class which just provides FilterEvent() virtual
method to be called by wxEvtHandler before starting process of any event.
Thus, inheriting from this class and overriding FilterEvent() allows to
capture and possibly handle or ignore all the events happening in the
Thus, inheriting from this class and overriding FilterEvent() allows
capturing and possibly handling or ignoring all the events happening in the
program. Of course, having event filters adds additional overhead to every
event processing and so should not be used lightly and your FilterEvent()
code should try to return as quickly as possible, especially for the events
@@ -22,7 +22,7 @@
An example of using this class:
@code
// This class allows to determine the last time the user has worked with
// This class allows determining the last time the user has worked with
// this application:
class LastActivityTimeDetector : public wxEventFilter
{
@@ -72,8 +72,8 @@
filter during its creation so you may also override FilterEvent() method in
your wxApp-derived class and, in fact, this is often the most convenient
way to do it. However creating a new class deriving directly from
wxEventFilter allows to isolate the event filtering code in its own
separate class and also to have several independent filters, if necessary.
wxEventFilter allows isolating the event filtering code in its own
separate class and also having several independent filters, if necessary.
@category{events}
@@ -118,7 +118,7 @@ public:
/**
Override this method to implement event pre-processing.
This method allows to filter all the events processed by the program,
This method allows filtering all the events processed by the program,
so you should try to return quickly from it to avoid slowing down the
program to a crawl.

2
interface/wx/fileconf.h
View File

@@ -96,7 +96,7 @@ public:
virtual bool Save(wxOutputStream& os, const wxMBConv& conv = wxConvAuto());
/**
Allows to set the mode to be used for the config file creation. For example, to
Allows setting the mode to be used for the config file creation. For example, to
create a config file which is not readable by other users (useful if it stores
some sensitive information, such as passwords), you could use @c SetUmask(0077).

4
interface/wx/filename.h
View File

@@ -193,7 +193,7 @@ wxULongLong wxInvalidSize;
invalid state and wxFileName::IsOk() returns false for it.
File names can be case-sensitive or not, the function wxFileName::IsCaseSensitive()
allows to determine this. The rules for determining whether the file name is
allows determining this. The rules for determining whether the file name is
absolute or relative also depend on the file name format and the only portable way
to answer this question is to use wxFileName::IsAbsolute() or wxFileName::IsRelative()
method.
@@ -517,7 +517,7 @@ public:
By default, all operations in this class work on the target of a
symbolic link (symlink) if the path of the file is actually a symlink.
Using this method allows to turn off this "symlink following" behaviour
Using this method allows turning off this "symlink following" behaviour
and apply the operations to this path itself, even if it is a symlink.
The following methods are currently affected by this option:

2
interface/wx/filepicker.h
View File

@@ -204,7 +204,7 @@ public:
automatically synchronized with button's value. Use functions
defined in wxPickerBase to modify the text control.
@style{wxDIRP_DIR_MUST_EXIST}
Creates a picker which allows to select only existing directories in
Creates a picker which allows selecting only existing directories in
the popup wxDirDialog. Notice that, as with @c wxFLP_FILE_MUST_EXIST,
it is still possible to enter a non-existent directory even when
this file is specified if @c wxDIRP_USE_TEXTCTRL style is also used.

6
interface/wx/font.h
View File

@@ -11,7 +11,7 @@
the generic properties of the font without hardcoding in the sources a specific
face name.
wxFontFamily thus allows to group the font face names of fonts with similar
wxFontFamily thus allows grouping the font face names of fonts with similar
properties. Most wxWidgets ports use lists of fonts for each font family
inspired by the data taken from http://www.codestyle.org/css/font-family.
*/
@@ -291,7 +291,7 @@ enum wxFontEncoding
@class wxFontInfo
This class is a helper used for wxFont creation using named parameter
idiom: it allows to specify various wxFont attributes using the chained
idiom: it allows specifying various wxFont attributes using the chained
calls to its clearly named methods instead of passing them in the fixed
order to wxFont constructors.
@@ -1169,7 +1169,7 @@ public:
/**
Sets the font size using a predefined symbolic size name.
This function allows to change font size to be (very) large or small
This function allows changing font size to be (very) large or small
compared to the standard font size.
@see SetSymbolicSizeRelativeTo().

2
interface/wx/fswatcher.h
View File

@@ -10,7 +10,7 @@
/**
@class wxFileSystemWatcher
The wxFileSystemWatcher class allows to receive notifications of file
The wxFileSystemWatcher class allows receiving notifications of file
system changes.
@note Implementation limitations: this class is currently implemented for

2
interface/wx/gdicmn.h
View File

@@ -1220,7 +1220,7 @@ void wxSetCursor(const wxCursor& cursor);
/**
Returns the dimensions of the work area on the display.
This is the same as wxGetClientDisplayRect() but allows to retrieve the
This is the same as wxGetClientDisplayRect() but allows retrieving the
individual components instead of the entire rectangle.
Any of the output pointers can be @NULL if the corresponding value is not

2
interface/wx/graphics.h
View File

@@ -1565,7 +1565,7 @@ public:
@class wxGraphicsPenInfo
This class is a helper used for wxGraphicsPen creation using named parameter
idiom: it allows to specify various wxGraphicsPen attributes using the chained
idiom: it allows specifying various wxGraphicsPen attributes using the chained
calls to its clearly named methods instead of passing them in the fixed
order to wxGraphicsPen constructors.

10
interface/wx/grid.h
View File

@@ -901,7 +901,7 @@ public:
/**
This class is reference counted: it is created with ref count of 1, so
calling DecRef() once will delete it. Calling IncRef() allows to lock
calling DecRef() once will delete it. Calling IncRef() allows locking
it until the matching DecRef() is called.
*/
void DecRef();
@@ -1005,7 +1005,7 @@ public:
/**
This class is reference counted: it is created with ref count of 1, so
calling DecRef() once will delete it. Calling IncRef() allows to lock
calling DecRef() once will delete it. Calling IncRef() allows locking
it until the matching DecRef() is called.
*/
void IncRef();
@@ -2935,7 +2935,7 @@ public:
The base class version returns the editor which was associated with the
specified @a typeName when it was registered RegisterDataType() but
this function may be overridden to return something different. This
allows to override an editor used for one of the standard types.
allows overriding an editor used for one of the standard types.
The caller must call DecRef() on the returned pointer.
*/
@@ -3667,7 +3667,7 @@ public:
/**
Disable interactive resizing of the specified column.
This method allows to disable resizing of an individual column in a
This method allows one to disable resizing of an individual column in a
grid where the columns are otherwise resizable (which is the case by
default).
@@ -4625,7 +4625,7 @@ public:
Sets the extra margins used around the grid area.
A grid may occupy more space than needed for its data display and
this function allows to set how big this extra space is
this function allows setting how big this extra space is
*/
void SetMargins(int extraWidth, int extraHeight);

2
interface/wx/headercol.h
View File

@@ -248,7 +248,7 @@ public:
/**
Set the column flags.
This method allows to set all flags at once, see also generic
This method allows setting all flags at once, see also generic
ChangeFlag(), SetFlag(), ClearFlag() and ToggleFlag() methods below as
well as specific SetResizeable(), SetSortable(), SetReorderable() and
SetHidden() ones.

2
interface/wx/help.h
View File

@@ -156,7 +156,7 @@ public:
/**
If the help viewer is not running, runs it, and searches for sections matching
the given keyword. If one match is found, the file is displayed at this section.
The optional parameter allows to search the index (wxHELP_SEARCH_INDEX)
The optional parameter allows searching the index (wxHELP_SEARCH_INDEX)
but this currently is only supported by the wxHtmlHelpController.
- @e WinHelp, MS HTML Help:

2
interface/wx/html/htmlcell.h
View File

@@ -476,7 +476,7 @@ public:
/**
Detach a child cell.
Detaching a cell removes it from this container and allows to reattach
Detaching a cell removes it from this container and allows reattaching
it to another one by using InsertCell(). Alternatively, this method can
be used to selectively remove some elements of the HTML document tree
by deleting the cell after calling it.

2
interface/wx/htmllbox.h
View File

@@ -97,7 +97,7 @@ protected:
background of the selected cells in the same way as GetSelectedTextColour().
It should be rarely, if ever, used because wxVListBox::SetSelectionBackground
allows to change the selection background for all cells at once and doing
allows changing the selection background for all cells at once and doing
anything more fancy is probably going to look strangely.
@see GetSelectedTextColour()

2
interface/wx/icon.h
View File

@@ -181,7 +181,7 @@ public:
/**
Attach a Windows icon handle.
This wxMSW-specific method allows to assign a native Windows @c HICON
This wxMSW-specific method allows assigning a native Windows @c HICON
(which must be castes to @c WXHICON opaque handle type) to wxIcon.
Notice that this means that the @c HICON will be destroyed by wxIcon
when it is destroyed.

4
interface/wx/listctrl.h
View File

@@ -127,7 +127,7 @@ enum
A special case of report view quite different from the other modes of the list
control is a virtual control in which the items data (including text, images
and attributes) is managed by the main program and is requested by the control
itself only when needed which allows to have controls with millions of items
itself only when needed which allows having controls with millions of items
without consuming much memory. To use virtual list control you must use
wxListCtrl::SetItemCount first and override at least wxListCtrl::OnGetItemText
(and optionally wxListCtrl::OnGetItemImage or wxListCtrl::OnGetItemColumnImage and
@@ -453,7 +453,7 @@ public:
/**
Finish editing the label.
This method allows to programmatically end editing a list control item
This method allows one to programmatically end editing a list control item
in place. Usually it will only be called when editing is in progress,
i.e. if GetEditControl() returns non-NULL. In particular, do not call
it from EVT_LIST_BEGIN_LABEL_EDIT handler as the edit control is not

2
interface/wx/longlong.h
View File

@@ -69,7 +69,7 @@ public:
//@}
/**
This allows to convert a double value to wxLongLong type.
This allows converting a double value to wxLongLong type.
Such conversion is not always possible in which case the result will be
silently truncated in a platform-dependent way.

2
interface/wx/mdi.h
View File

@@ -306,7 +306,7 @@ public:
SetWindowMenu() is called again).
To remove the window completely, you can use the wxFRAME_NO_WINDOW_MENU
window style but this function also allows to do it by passing @NULL
window style but this function also allows doing it by passing @NULL
pointer as @a menu.
The menu may include the items with the following standard identifiers

2
interface/wx/modalhook.h
View File

@@ -7,7 +7,7 @@
/////////////////////////////////////////////////////////////////////////////
/**
Allows to intercept all modal dialog calls.
Allows intercepting all modal dialog calls.
This class can be used to hook into normal modal dialog handling for some
special needs. One of the most common use cases is for testing: as

2
interface/wx/msgout.h
View File

@@ -10,7 +10,7 @@
Simple class allowing to write strings to various output channels.
wxMessageOutput is a low-level class and doesn't provide any of the
conveniences of wxLog. It simply allows to write a message to some output
conveniences of wxLog. It simply allows writing a message to some output
channel: usually file or standard error but possibly also a message box.
While use of wxLog and related functions is preferable in many cases
sometimes this simple interface may be more convenient.

4
interface/wx/mstream.h
View File

@@ -8,7 +8,7 @@
/**
@class wxMemoryOutputStream
This class allows to use all methods taking a wxOutputStream reference to write
This class allows using all methods taking a wxOutputStream reference to write
to in-memory data.
Example:
@@ -72,7 +72,7 @@ public:
/**
@class wxMemoryInputStream
This class allows to use all methods taking a wxInputStream reference to read
This class allows using all methods taking a wxInputStream reference to read
in-memory data.
Example:

2
interface/wx/nativewin.h
View File

@@ -10,7 +10,7 @@
/**
@class wxNativeWindow
Allows to embed a native widget in an application using wxWidgets.
Allows embedding a native widget in an application using wxWidgets.
This class can be used as a bridge between wxWidgets and native GUI
toolkit, i.e. standard Windows controls under MSW, GTK+ widgets or Cocoa

2
interface/wx/notifmsg.h
View File

@@ -8,7 +8,7 @@
/**
@class wxNotificationMessage
This class allows to show the user a message non intrusively.
This class allows showing the user a message non intrusively.
Currently it is implemented natively for Windows, OS X, GTK and uses
generic toast notifications under the other platforms. It's not recommended

2
interface/wx/pen.h
View File

@@ -105,7 +105,7 @@ enum wxPenCap
@class wxPenInfo
This class is a helper used for wxPen creation using named parameter
idiom: it allows to specify various wxPen attributes using the chained
idiom: it allows specifying various wxPen attributes using the chained
calls to its clearly named methods instead of passing them in the fixed
order to wxPen constructors.

2
interface/wx/persist.h
View File

@@ -62,7 +62,7 @@ public:
Globally disable restoring the persistence object properties.
By default, restoring properties in Restore() is enabled but this
function allows to disable it. This is mostly useful for testing.
function allows disabling it. This is mostly useful for testing.
@see DisableSaving()
*/

2
interface/wx/platinfo.h
View File

@@ -11,7 +11,7 @@
whose version can be detected at run-time.
The values of the constants are chosen so that they can be combined as flags;
this allows to check for operating system families like e.g. @c wxOS_MAC and @c wxOS_UNIX.
this allows checking for operating system families like e.g. @c wxOS_MAC and @c wxOS_UNIX.
Note that you can obtain more detailed information about the current OS
version in use by checking the major, minor, and micro version numbers

4
interface/wx/process.h
View File

@@ -67,7 +67,7 @@ public:
/**
Creates an object without any associated parent (and hence no id neither)
but allows to specify the @a flags which can have the value of
but allows specifying the @a flags which can have the value of
@c wxPROCESS_DEFAULT or @c wxPROCESS_REDIRECT.
Specifying the former value has no particular effect while using the latter
@@ -174,7 +174,7 @@ public:
Returns @true if there is data to be read on the child process standard
output stream.
This allows to write simple (and extremely inefficient) polling-based code
This allows writing simple (and extremely inefficient) polling-based code
waiting for a better mechanism in future wxWidgets versions.
See the @ref page_samples_exec "exec sample" for an example of using this
function.

4
interface/wx/progdlg.h
View File

@@ -180,8 +180,8 @@ public:
Normally a Cancel button press is indicated by Update() returning
@false but sometimes it may be more convenient to check if the dialog
was cancelled from elsewhere in the code and this function allows to
do it.
was cancelled from elsewhere in the code and this function allows
doing it.
It always returns @false if the Cancel button is not shown at all.

2
interface/wx/propgrid/propgrid.h
View File

@@ -229,7 +229,7 @@ wxPG_EX_NO_TOOLBAR_DIVIDER = 0x04000000,
*/
wxPG_EX_TOOLBAR_SEPARATOR = 0x08000000,
/** Allows to take focus on the entire area (on canvas)
/** Allows taking focus on the entire area (on canvas)
even if wxPropertyGrid is not a standalone control.
@hideinitializer
*/

4
interface/wx/rearrangectrl.h
View File

@@ -13,8 +13,8 @@
A listbox-like control allowing the user to rearrange the items and to
enable or disable them.
This class allows to change the order of the items shown in it as well as
to check or uncheck them individually. The data structure used to allow
This class allows changing the order of the items shown in it as well as
checking or unchecking them individually. The data structure used to allow
this is the order array which contains the items indices indexed by their
position with an added twist that the unchecked items are represented by
the bitwise complement of the corresponding index (for any architecture

2
interface/wx/richtooltip.h
View File

@@ -51,7 +51,7 @@ enum wxTipKind
wxTipKind_Auto
};
/**
Allows to show a tool tip with more customizations than wxToolTip.
Allows showing a tool tip with more customizations than wxToolTip.
Using this class is very simple, to give a standard warning for a password
text control if the password was entered correctly you could simply do:

4
interface/wx/simplebook.h
View File

@@ -73,7 +73,7 @@ public:
/**
Set the effects to use for showing and hiding the pages.
This method allows to specify the effects passed to
This method allows specifying the effects passed to
wxWindow::ShowWithEffect() and wxWindow::HideWithEffect() respectively
when the pages need to be shown or hidden.
@@ -102,7 +102,7 @@ public:
/**
Set the effect timeout to use for showing and hiding the pages.
This method allows to configure the timeout arguments passed to
This method allows configuring the timeout arguments passed to
wxWindow::ShowWithEffect() and wxWindow::HideWithEffect() if a
non-default effect is used.

2
interface/wx/snglinst.h
View File

@@ -8,7 +8,7 @@
/**
@class wxSingleInstanceChecker
wxSingleInstanceChecker class allows to check that only a single instance of a
wxSingleInstanceChecker class allows checking that only a single instance of a
program is running.
To do it, you should create an object of this class. As long as this object

6
interface/wx/stc/stc.h
View File

@@ -6829,7 +6829,7 @@ public:
void SetWrapVisualFlags(int wrapVisualFlags);
/**
Retrive the display mode of visual flags for wrapped lines.
Retrieve the display mode of visual flags for wrapped lines.
The return value will be a bit list containing one or more of the
@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAG_NONE wxSTC_WRAPVISUALFLAG_* @endlink constants.
@@ -6845,7 +6845,7 @@ public:
void SetWrapVisualFlagsLocation(int wrapVisualFlagsLocation);
/**
Retrive the location of visual flags for wrapped lines.
Retrieve the location of visual flags for wrapped lines.
The return value will be a bit list containing one or more of the
@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAGLOC_DEFAULT wxSTC_WRAPVISUALFLAGLOC_* @endlink constants.
@@ -6858,7 +6858,7 @@ public:
void SetWrapStartIndent(int indent);
/**
Retrive the start indent for wrapped lines.
Retrieve the start indent for wrapped lines.
*/
int GetWrapStartIndent() const;

2
interface/wx/stockitem.h
View File

@@ -39,7 +39,7 @@ enum wxStockLabelQueryFlag
Return the label without any ellipsis at the end.
By default, stock items text is returned with ellipsis, if appropriate,
this flag allows to avoid having it. So using the same example as
this flag allows one to avoid having it. So using the same example as
above, the returned string would be "Print" or "&Print" if
wxSTOCK_WITH_MNEMONIC were also used.

2
interface/wx/strconv.h
View File

@@ -86,7 +86,7 @@ public:
This is the most general function for converting a multibyte string to
a wide string, cMB2WC() may be often more convenient, however this
function is the most efficient one as it allows to avoid any
function is the most efficient one as it allows avoiding any
unnecessary copying.
The main case is when @a dst is not @NULL and @a srcLen is not

2
interface/wx/string.h
View File

@@ -2038,7 +2038,7 @@ public:
//@{
/**
Allows to extend a function with the signature:
Allows extending a function with the signature:
@code bool SomeFunc(const wxUniChar& c) @endcode
which operates on a single character, to an entire wxString.

6
interface/wx/sysopt.h
View File

@@ -34,7 +34,7 @@
If set to non-zero value, abort the program if an assertion fails. The
default behaviour in case of assertion failure depends on the build mode
and can be changed by overriding wxApp::OnAssertFailure() but setting
this option allows to change it without modifying the program code and
this option allows changing it without modifying the program code and
also applies to asserts which may happen before the wxApp object
creation or after its destruction.
@endFlagTable
@@ -81,8 +81,8 @@
@flag{gtk.tlw.can-set-transparent}
wxTopLevelWindow::CanSetTransparent() method normally tries to detect
automatically whether transparency for top level windows is currently
supported, however this may sometimes fail and this option allows to
override the automatic detection. Setting it to 1 makes the transparency
supported, however this may sometimes fail and this option allows
overriding the automatic detection. Setting it to 1 makes the transparency
be always available (setting it can still fail, of course) and setting it
to 0 makes it always unavailable.
@flag{gtk.desktop}

2
interface/wx/textcompleter.h
View File

@@ -21,7 +21,7 @@
one after the user finished entering the first one and so on.
When inheriting from this class you need to implement its two pure virtual
methods. This allows to return the results incrementally and may or not be
methods. This allows returning the results incrementally and may or not be
convenient depending on where do they come from. If you prefer to return
all the completions at once, you should inherit from wxTextCompleterSimple
instead.

4
interface/wx/textctrl.h
View File

@@ -960,7 +960,7 @@ public:
@style{wxTE_READONLY}
The text will not be user-editable.
@style{wxTE_RICH}
Use rich text control under MSW, this allows to have more than 64KB
Use rich text control under MSW, this allows having more than 64KB
of text in the control. This style is ignored under other platforms.
@style{wxTE_RICH2}
Use rich text control version 2.0 or higher under MSW, this style is
@@ -1469,7 +1469,7 @@ public:
/**
Converts given text position to client coordinates in pixels.
This function allows to find where is the character at the given
This function allows finding where is the character at the given
position displayed in the text control.
@onlyfor{wxmsw,wxgtk}. Additionally, wxGTK only implements this method

4
interface/wx/textentry.h
View File

@@ -68,7 +68,7 @@ public:
This method should be used instead of AutoComplete() overload taking
the array of possible completions if the total number of strings is too
big as it allows to return the completions dynamically, depending on
big as it allows returning the completions dynamically, depending on
the text already entered by user and so is more efficient.
The specified @a completer object will be used to retrieve the list of
@@ -399,7 +399,7 @@ public:
This function sets the maximum number of characters the user can enter
into the control.
In other words, it allows to limit the text value length to @a len not
In other words, it allows limiting the text value length to @a len not
counting the terminating @c NUL character.
If @a len is 0, the previously set max length limit, if any, is discarded

4
interface/wx/textfile.h
View File

@@ -22,7 +22,7 @@ enum wxTextFileType
/**
@class wxTextFile
The wxTextFile is a simple class which allows to work with text files on line by
The wxTextFile is a simple class which allows working with text files on line by
line basis. It also understands the differences in line termination characters
under different platforms and will not do anything bad to files with "non
native" line termination sequences - in fact, it can be also used to modify the
@@ -169,7 +169,7 @@ public:
/**
Gets the last line of the file.
Together with GetPrevLine() it allows to enumerate the lines
Together with GetPrevLine() it allows enumerating the lines
in the file from the end to the beginning like this:
@code

2
interface/wx/toolbar.h
View File

@@ -809,7 +809,7 @@ public:
/**
Removes the given tool from the toolbar but doesn't delete it. This
allows to insert/add this tool back to this (or another) toolbar later.
allows inserting/adding this tool back to this (or another) toolbar later.
@note It is unnecessary to call Realize() for the change to take place,
it will happen immediately.

4
interface/wx/toplevel.h
View File

@@ -467,8 +467,8 @@ public:
void SetIcon(const wxIcon& icon);
/**
Sets several icons of different sizes for this window: this allows to
use different icons for different situations (e.g. task switching bar,
Sets several icons of different sizes for this window: this allows
using different icons for different situations (e.g. task switching bar,
taskbar, window title bar) instead of scaling, with possibly bad looking
results, the only icon set by SetIcon().

4
interface/wx/translation.h
View File

@@ -7,7 +7,7 @@
/**
This class allows to get translations for strings.
This class allows getting translations for strings.
In wxWidgets this class manages message catalogs which contain the
translations of the strings used to the current language. Unlike wxLocale,
@@ -539,7 +539,7 @@ public:
If @a context is not empty (notice that this argument is only available
starting from wxWidgets 3.1.1), item translation is looked up in the
specified context. This allows to have different translations for the same
specified context. This allows having different translations for the same
string appearing in different contexts, e.g. it may be necessary to
translate the same English "Open" verb differently depending on the object
it applies to. To do this, you need to use @c msgctxt in the source message

2
interface/wx/treelist.h
View File

@@ -24,7 +24,7 @@ enum
Don't show the column headers.
By default this control shows the column headers, using this class
allows to avoid this and show only the data.
allows avoiding this and showing only the data.
@since 2.9.5
*/

6
interface/wx/utils.h
View File

@@ -868,8 +868,8 @@ wxString wxGetOsDescription();
/**
Gets the version and the operating system ID for currently running OS.
The returned wxOperatingSystemId value can be used for a basic categorization
of the OS family; the major, minor, and micro version numbers allows to
detect a specific system.
of the OS family; the major, minor, and micro version numbers allows
detecting a specific system.
If on Unix-like systems the version can't be detected all three version
numbers will have a value of -1.
@@ -1026,7 +1026,7 @@ enum
Always show the child process console under MSW.
The child console is hidden by default if the child IO is redirected,
this flag allows to change this and show it nevertheless.
this flag allows changing this and showing it nevertheless.
This flag is ignored under the other platforms.
*/

2
interface/wx/valnum.h
View File

@@ -364,7 +364,7 @@ public:
/**
Creates a wxFloatingPointValidator object with automatic type deduction.
Similarly to wxMakeIntegerValidator(), this function allows to avoid
Similarly to wxMakeIntegerValidator(), this function allows avoiding
explicitly specifying the validator type.
@since 2.9.2

2
interface/wx/wfstream.h
View File

@@ -276,7 +276,7 @@ public:
/**
@class wxFFileStream
This stream allows to both read from and write to a file using buffered
This stream allows both reading from and writing to a file using buffered
STDIO functions.
@library{wxbase}

2
interface/wx/window.h
View File

@@ -257,7 +257,7 @@ enum wxWindowVariant
@style{wxWS_EX_BLOCK_EVENTS}
wxCommandEvents and the objects of the derived classes are
forwarded to the parent window and so on recursively by default.
Using this flag for the given window allows to block this
Using this flag for the given window allows blocking this
propagation at this window, i.e. prevent the events from being
propagated further upwards. Dialogs have this flag on by default
for the reasons explained in the @ref overview_events.

2
interface/wx/xml/xml.h
View File

@@ -886,7 +886,7 @@ public:
void SetEncoding(const wxString& enc);
/**
Sets the enconding of the file which will be used to save the document.
Sets the encoding of the file which will be used to save the document.
*/
void SetFileEncoding(const wxString& encoding);