No code changes, fixed various typos.
Applied patch by snowleopard2 fixing typos in interface/. Extended the fixes throughout trunk. Closes #13076. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67384 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -372,7 +372,7 @@ public:
|
||||
|
||||
/**
|
||||
This function may be called if something fatal happens: an unhandled
|
||||
exception under Win32 or a a fatal signal under Unix, for example. However,
|
||||
exception under Win32 or a fatal signal under Unix, for example. However,
|
||||
this will not happen by default: you have to explicitly call
|
||||
wxHandleFatalExceptions() to enable this.
|
||||
|
||||
|
@@ -201,7 +201,7 @@ public:
|
||||
A transparent brush is simply a brush with wxBRUSHSTYLE_TRANSPARENT
|
||||
style.
|
||||
|
||||
Notice that this function works even for non-initialized brushs (for
|
||||
Notice that this function works even for non-initialized brushes (for
|
||||
which it returns @false) unlike tests of the form <code>GetStyle() ==
|
||||
wxBRUSHSTYLE_TRANSPARENT</code> which would assert if the brush is
|
||||
invalid.
|
||||
|
@@ -104,7 +104,7 @@ public:
|
||||
|
||||
/**
|
||||
Returns @true if the caret is visible and @false if it is permanently
|
||||
hidden (if it is is blinking and not shown currently but will be after
|
||||
hidden (if it is blinking and not shown currently but will be after
|
||||
the next blink, this method still returns @true).
|
||||
*/
|
||||
bool IsVisible() const;
|
||||
|
@@ -37,7 +37,7 @@
|
||||
|
||||
This macro can be used in the code which needs to compile with both
|
||||
wxWidgets 2 and 3 versions in places where v2 API requires a Unicode string
|
||||
(in Unicode build) and v3 API only accepts a standard standard narrow
|
||||
(in Unicode build) and v3 API only accepts a standard narrow
|
||||
string as in e.g. wxCmdLineEntryDesc structure objects initializers.
|
||||
|
||||
Example of use:
|
||||
|
@@ -75,7 +75,7 @@ public:
|
||||
know the ordering of Undos; the user can never Undo at an arbitrary
|
||||
position in the command history.
|
||||
- Restore the entire document state (perhaps using document
|
||||
transactioning). Potentially very inefficient, but possibly easier to
|
||||
transacting). Potentially very inefficient, but possibly easier to
|
||||
code if the user interface and data are complex, and an "inverse
|
||||
execute" operation is hard to write. The docview sample uses the
|
||||
first method, to remove or restore segments in the drawing.
|
||||
|
@@ -25,7 +25,7 @@ public:
|
||||
of colour data, which will be copied to the colour dialog's colour
|
||||
data.
|
||||
|
||||
Custom colours from colour data object will be be used in the dialog's
|
||||
Custom colours from colour data object will be used in the dialog's
|
||||
colour palette. Invalid entries in custom colours list will be ignored
|
||||
on some platforms(GTK) or replaced with white colour on platforms where
|
||||
custom colours palette has fixed size (MSW).
|
||||
|
@@ -187,7 +187,7 @@ public:
|
||||
/**
|
||||
Sets the RGB intensity values using the given values (first overload),
|
||||
extracting them from the packed long (second overload), using the given
|
||||
string (third overloard).
|
||||
string (third overload).
|
||||
|
||||
When using third form, Set() accepts: colour names (those listed in
|
||||
wxColourDatabase), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax
|
||||
|
@@ -87,7 +87,7 @@ public:
|
||||
void SetCustomColour(int i, const wxColour& colour);
|
||||
|
||||
/**
|
||||
Converts the colours saved in this class in a string form, separing
|
||||
Converts the colours saved in this class in a string form, separating
|
||||
the various colours with a comma.
|
||||
*/
|
||||
wxString ToString() const;
|
||||
|
@@ -864,7 +864,7 @@ protected:
|
||||
/**
|
||||
This member function is not normally called in application code.
|
||||
Instead, it can be implemented in a derived class to return default
|
||||
wxComboPopup, incase @a popup is @NULL.
|
||||
wxComboPopup, in case @a popup is @NULL.
|
||||
|
||||
@note If you have implemented OnButtonClick() to do something else than
|
||||
show the popup, then DoSetPopupControl() must always set @a popup
|
||||
|
@@ -312,7 +312,7 @@ public:
|
||||
@n The @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS style can be helpful if your
|
||||
config file must be read or written to by a non-wxWidgets program
|
||||
(which might not understand the escape characters). Note, however,
|
||||
that if @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is is
|
||||
that if @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is
|
||||
now your application's responsibility to ensure that there is no
|
||||
newline or other illegal characters in a value, before writing that
|
||||
value to the file.
|
||||
@@ -763,7 +763,7 @@ public:
|
||||
|
||||
/**
|
||||
Delete the whole underlying object (disk file, registry key, ...).
|
||||
Primarly for use by uninstallation routine.
|
||||
Primarily for use by uninstallation routine.
|
||||
*/
|
||||
virtual bool DeleteAll() = 0;
|
||||
|
||||
|
@@ -36,7 +36,7 @@ public:
|
||||
@param stream
|
||||
The output stream.
|
||||
@param conv
|
||||
Charset conversion object object used to encoding Unicode strings
|
||||
Charset conversion object used to encoding Unicode strings
|
||||
before writing them to the stream in Unicode mode (see
|
||||
WriteString() for a detailed description). Note that you must not
|
||||
destroy @a conv before you destroy this wxDataOutputStream
|
||||
@@ -184,7 +184,7 @@ public:
|
||||
@param stream
|
||||
The input stream.
|
||||
@param conv
|
||||
Charset conversion object object used to decode strings in Unicode
|
||||
Charset conversion object used to decode strings in Unicode
|
||||
mode (see ReadString() for a detailed description). Note that you
|
||||
must not destroy @a conv before you destroy this wxDataInputStream
|
||||
instance!
|
||||
@@ -272,7 +272,7 @@ public:
|
||||
In Unicode build of wxWidgets, the fuction first reads multibyte
|
||||
(char*) string from the stream and then converts it to Unicode using
|
||||
the @e conv object passed to constructor and returns the result as
|
||||
wxString. You are responsible for using the same convertor as when
|
||||
wxString. You are responsible for using the same converter as when
|
||||
writing the stream.
|
||||
|
||||
@see wxDataOutputStream::WriteString()
|
||||
|
@@ -10,7 +10,7 @@
|
||||
@class wxBufferedDC
|
||||
|
||||
This class provides a simple way to avoid flicker: when drawing on it,
|
||||
everything is infact first drawn on an in-memory buffer (a wxBitmap) and
|
||||
everything is in fact first drawn on an in-memory buffer (a wxBitmap) and
|
||||
then copied to the screen, using the associated wxDC, only once, when this
|
||||
object is destroyed. wxBufferedDC itself is typically associated with
|
||||
wxClientDC, if you want to use it in your @c EVT_PAINT handler, you should
|
||||
@@ -120,7 +120,7 @@ public:
|
||||
|
||||
The difference between wxBufferedPaintDC and this class is that this class
|
||||
won't double-buffer on platforms which have native double-buffering
|
||||
already, avoiding any unneccessary buffering to avoid flicker.
|
||||
already, avoiding any unnecessary buffering to avoid flicker.
|
||||
|
||||
wxAutoBufferedPaintDC is simply a typedef of wxPaintDC on platforms that
|
||||
have native double-buffering, otherwise, it is a typedef of
|
||||
|
@@ -253,7 +253,7 @@ public:
|
||||
/**
|
||||
Retrieves the name (relative to GetDirectory()) and the description of
|
||||
the file with the given index. If @a n is greater than or equal to the
|
||||
number of filse, @false is returned.
|
||||
number of files, then @false is returned.
|
||||
*/
|
||||
bool GetFile(size_t n, wxString* name, wxString* desc) const;
|
||||
|
||||
|
@@ -33,7 +33,7 @@ enum wxOrientation
|
||||
*/
|
||||
wxBOTH = wxVERTICAL | wxHORIZONTAL,
|
||||
|
||||
/// A synonim for @c wxBOTH.
|
||||
/// A synonym for @c wxBOTH.
|
||||
wxORIENTATION_MASK = wxBOTH
|
||||
};
|
||||
|
||||
|
@@ -88,7 +88,7 @@ enum wxDialogLayoutAdaptationMode
|
||||
Equivalent to a combination of wxCAPTION, wxCLOSE_BOX and
|
||||
wxSYSTEM_MENU (the last one is not used under Unix).
|
||||
@style{wxRESIZE_BORDER}
|
||||
Display a resizeable frame around the window.
|
||||
Display a resizable frame around the window.
|
||||
@style{wxSYSTEM_MENU}
|
||||
Display a system menu.
|
||||
@style{wxCLOSE_BOX}
|
||||
@@ -638,7 +638,7 @@ public:
|
||||
/**
|
||||
@class wxDialogLayoutAdapter
|
||||
|
||||
This abstract class is the base for classes that help wxWidgets peform
|
||||
This abstract class is the base for classes that help wxWidgets perform
|
||||
run-time layout adaptation of dialogs. Principally, this is to cater for
|
||||
small displays by making part of the dialog scroll, but the application
|
||||
developer may find other uses for layout adaption.
|
||||
|
@@ -207,7 +207,7 @@ public:
|
||||
bool IsConnectedEvent() const;
|
||||
|
||||
/**
|
||||
Does this event come from wxDialUpManager::Dial() or from some extrenal
|
||||
Does this event come from wxDialUpManager::Dial() or from some external
|
||||
process (i.e. does it result from our own attempt to establish the
|
||||
connection)?
|
||||
*/
|
||||
|
@@ -683,7 +683,7 @@ public:
|
||||
@param noTemplates
|
||||
Number of templates being pointed to by the templates pointer.
|
||||
@param sort
|
||||
If more than one template is passed in in templates, then this
|
||||
If more than one template is passed into templates, then this
|
||||
parameter indicates whether the list of templates that the user
|
||||
will have to choose from is sorted or not when shown the choice box
|
||||
dialog. Default is @false.
|
||||
@@ -709,7 +709,7 @@ public:
|
||||
@param noTemplates
|
||||
Number of templates being pointed to by the templates pointer.
|
||||
@param sort
|
||||
If more than one template is passed in in templates, then this
|
||||
If more than one template is passed into templates, then this
|
||||
parameter indicates whether the list of templates that the user
|
||||
will have to choose from is sorted or not when shown the choice box
|
||||
dialog. Default is @false.
|
||||
|
@@ -124,7 +124,7 @@
|
||||
however dumb, C++ compiler in the world.
|
||||
|
||||
Remember to include @<wx/arrimpl.cpp@> just before each
|
||||
WX_DEFINE_OBJARRAY() ocurrence in your code, even if you have several in
|
||||
WX_DEFINE_OBJARRAY() occurrence in your code, even if you have several in
|
||||
the same file.
|
||||
|
||||
Things are much simpler for wxArray and wxSortedArray however: it is enough
|
||||
|
@@ -67,7 +67,7 @@ class wxFindDialogEvent : public wxCommandEvent
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constuctor used by wxWidgets only.
|
||||
Constructor used by wxWidgets only.
|
||||
*/
|
||||
wxFindDialogEvent(wxEventType commandType = wxEVT_NULL,
|
||||
int id = 0);
|
||||
@@ -117,7 +117,7 @@ class wxFindReplaceData : public wxObject
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constuctor initializes the flags to default value (0).
|
||||
Constructor initializes the flags to default value (0).
|
||||
*/
|
||||
wxFindReplaceData(wxUint32 flags = 0);
|
||||
|
||||
|
@@ -106,7 +106,7 @@ public:
|
||||
void Detach();
|
||||
|
||||
/**
|
||||
Returns @true if the an attempt has been made to read @e past
|
||||
Returns @true if an attempt has been made to read @e past
|
||||
the end of the file.
|
||||
|
||||
Note that the behaviour of the file descriptor based class wxFile is different as
|
||||
|
@@ -129,7 +129,7 @@ wxULongLong wxInvalidSize;
|
||||
wxFileName::IsDirReadable() use wxFileName::GetPath() whereas methods dealing
|
||||
with file names like wxFileName::IsFileReadable() use wxFileName::GetFullPath().
|
||||
|
||||
If it is not known wether a string contains a directory name or a complete
|
||||
If it is not known whether a string contains a directory name or a complete
|
||||
file name (such as when interpreting user input) you need to use the static
|
||||
function wxFileName::DirExists() (or its identical variants wxDir::Exists() and
|
||||
wxDirExists()) and construct the wxFileName instance accordingly.
|
||||
@@ -332,7 +332,7 @@ public:
|
||||
wxPathFormat format = wxPATH_NATIVE);
|
||||
|
||||
/**
|
||||
Creates the file name from volumne, path, name and extension.
|
||||
Creates the file name from volume, path, name and extension.
|
||||
*/
|
||||
void Assign(const wxString& volume, const wxString& path,
|
||||
const wxString& name,
|
||||
@@ -341,7 +341,7 @@ public:
|
||||
wxPathFormat format = wxPATH_NATIVE);
|
||||
|
||||
/**
|
||||
Creates the file name from volumne, path, name and extension.
|
||||
Creates the file name from volume, path, name and extension.
|
||||
*/
|
||||
void Assign(const wxString& volume, const wxString& path,
|
||||
const wxString& name,
|
||||
@@ -558,7 +558,7 @@ public:
|
||||
suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes,
|
||||
gigabytes and terabytes respectively. With the IEC convention the names
|
||||
of the units are changed to B, KiB, MiB, GiB and TiB for bytes,
|
||||
kibibytes, mebibyes, gibibytes and tebibytes. Finally, with SI
|
||||
kibibytes, mebibytes, gibibytes and tebibytes. Finally, with SI
|
||||
convention the same B, KB, MB, GB and TB suffixes are used but in their
|
||||
correct SI meaning, i.e. as multiples of 1000 and not 1024.
|
||||
|
||||
|
@@ -70,7 +70,7 @@
|
||||
recommended to only use it together with wxCAPTION for consistent
|
||||
behaviour under all platforms.
|
||||
@style{wxRESIZE_BORDER}
|
||||
Displays a resizeable border around the window.
|
||||
Displays a resizable border around the window.
|
||||
@style{wxFRAME_TOOL_WINDOW}
|
||||
Causes a frame with a small title bar to be created; the frame does
|
||||
not appear in the taskbar under Windows or GTK+.
|
||||
@@ -89,7 +89,7 @@
|
||||
with the SetShape() method.
|
||||
@endStyleTable
|
||||
|
||||
The default frame style is for normal, resizeable frames.
|
||||
The default frame style is for normal, resizable frames.
|
||||
To create a frame which cannot be resized by user, you may use the following
|
||||
combination of styles:
|
||||
|
||||
|
@@ -160,7 +160,7 @@ public:
|
||||
@class wxFileSystemWatcherEvent
|
||||
|
||||
A class of events sent when a file system event occurs. Types of events
|
||||
reported may vary depending on a platfrom, however all platforms report
|
||||
reported may vary depending on a platform, however all platforms report
|
||||
at least creation of new file/directory and access, modification, move
|
||||
(rename) or deletion of an existing one.
|
||||
|
||||
|
@@ -217,7 +217,7 @@ public:
|
||||
|
||||
The wxGBSizerItem class is used by the wxGridBagSizer for tracking the
|
||||
items in the sizer. It adds grid position and spanning information to the
|
||||
normal wxSizerItem by adding wxGBPosition and wxGBSpan attrbibutes. Most of
|
||||
normal wxSizerItem by adding wxGBPosition and wxGBSpan attributes. Most of
|
||||
the time you will not need to use a wxGBSizerItem directly in your code,
|
||||
but there are a couple of cases where it is handy.
|
||||
|
||||
@@ -268,7 +268,7 @@ public:
|
||||
//@}
|
||||
|
||||
/**
|
||||
Returns @true if this item and the @a other item instersect.
|
||||
Returns @true if this item and the @a other item intersect.
|
||||
*/
|
||||
bool Intersects(const wxGBSizerItem& other);
|
||||
/**
|
||||
|
@@ -150,8 +150,8 @@ public:
|
||||
wxPoint2DDouble GetPosition();
|
||||
wxSize GetSize();
|
||||
|
||||
// for the edge and corner accessors there are two setters conterparts, the Set.. functions keep the other corners at their
|
||||
// position whenever sensible, the Move.. functions keep the size of the rect and move the other corners apropriately
|
||||
// for the edge and corner accessors there are two setters counterparts, the Set.. functions keep the other corners at their
|
||||
// position whenever sensible, the Move.. functions keep the size of the rect and move the other corners appropriately
|
||||
|
||||
wxDouble GetLeft() const;
|
||||
void SetLeft( wxDouble n );
|
||||
@@ -241,8 +241,8 @@ public:
|
||||
wxPoint2DInt GetPosition();
|
||||
wxSize GetSize();
|
||||
|
||||
// for the edge and corner accessors there are two setters conterparts, the Set.. functions keep the other corners at their
|
||||
// position whenever sensible, the Move.. functions keep the size of the rect and move the other corners apropriately
|
||||
// for the edge and corner accessors there are two setters counterparts, the Set.. functions keep the other corners at their
|
||||
// position whenever sensible, the Move.. functions keep the size of the rect and move the other corners appropriately
|
||||
|
||||
wxInt32 GetLeft() const;
|
||||
void SetLeft( wxInt32 n );
|
||||
|
@@ -137,7 +137,7 @@ enum
|
||||
/// 1 for multisampling support (antialiasing)
|
||||
WX_GL_SAMPLE_BUFFERS,
|
||||
|
||||
/// 4 for 2x2 antialising supersampling on most graphics cards
|
||||
/// 4 for 2x2 antialiasing supersampling on most graphics cards
|
||||
WX_GL_SAMPLES
|
||||
|
||||
};
|
||||
@@ -215,7 +215,7 @@ public:
|
||||
constants. If a constant should be followed by a value, put it in
|
||||
the next array position. For example, WX_GL_DEPTH_SIZE should be
|
||||
followed by the value that indicates the number of bits for the
|
||||
depth buffer, e.g:
|
||||
depth buffer, e.g.:
|
||||
@code
|
||||
attribList[n++] = WX_GL_DEPTH_SIZE;
|
||||
attribList[n++] = 32;
|
||||
|
@@ -403,7 +403,7 @@ public:
|
||||
/**
|
||||
Creates a native brush with a radial gradient.
|
||||
|
||||
The brush originats at (@a xo, @a yc) and ends on a circle around
|
||||
The brush originates at (@a xo, @a yc) and ends on a circle around
|
||||
(@a xc, @a yc) with the given @a radius.
|
||||
|
||||
The gradient may be specified either by its start and end colours @a
|
||||
|
@@ -1630,7 +1630,7 @@ struct wxGridSizesInfo
|
||||
The default table class is called wxGridStringTable and holds an array of
|
||||
strings. An instance of such a class is created by CreateGrid().
|
||||
|
||||
wxGridCellRenderer is the abstract base class for rendereing contents in a
|
||||
wxGridCellRenderer is the abstract base class for rendering contents in a
|
||||
cell. The following renderers are predefined:
|
||||
|
||||
- wxGridCellBoolRenderer
|
||||
@@ -2781,7 +2781,7 @@ public:
|
||||
@a resizeExistingRows is @true.
|
||||
|
||||
If @a height is less than GetRowMinimalAcceptableHeight(), then the
|
||||
minimal acceptable heihgt is used instead of it.
|
||||
minimal acceptable height is used instead of it.
|
||||
*/
|
||||
void SetDefaultRowSize(int height, bool resizeExistingRows = false);
|
||||
|
||||
@@ -3009,7 +3009,7 @@ public:
|
||||
Notice that currently there is no way to make some columns resizable in
|
||||
a grid where columns can't be resized by default as there doesn't seem
|
||||
to be any need for this in practice. There is also no way to make the
|
||||
column marked as fixed using this method resizeable again because it is
|
||||
column marked as fixed using this method resizable again because it is
|
||||
supposed that fixed columns are used for static parts of the grid and
|
||||
so should remain fixed during the entire grid lifetime.
|
||||
|
||||
|
@@ -221,7 +221,7 @@ public:
|
||||
/**
|
||||
Set the minimal column width.
|
||||
|
||||
This method can be used with resizeable columns (i.e. those for which
|
||||
This method can be used with resizable columns (i.e. those for which
|
||||
wxCOL_RESIZABLE flag is set in GetFlags() or, alternatively,
|
||||
IsResizeable() returns @true) to prevent the user from making them
|
||||
narrower than the given width.
|
||||
@@ -302,11 +302,11 @@ public:
|
||||
Call this to enable or disable interactive resizing of the column by
|
||||
the user.
|
||||
|
||||
By default, the columns are resizeable.
|
||||
By default, the columns are resizable.
|
||||
|
||||
Equivalent to ChangeFlag(wxCOL_RESIZABLE, resizeable).
|
||||
Equivalent to ChangeFlag(wxCOL_RESIZABLE, resizable).
|
||||
*/
|
||||
virtual void SetResizeable(bool resizeable);
|
||||
virtual void SetResizeable(bool resizable);
|
||||
|
||||
/**
|
||||
Allow clicking the column to sort the control contents by the field in
|
||||
|
@@ -208,7 +208,7 @@ public:
|
||||
virtual bool LoadFile(const wxString& file = wxEmptyString);
|
||||
|
||||
/**
|
||||
Overrideable member called when this application's viewer is quit by the user.
|
||||
Overridable member called when this application's viewer is quit by the user.
|
||||
This does not work for all help controllers.
|
||||
*/
|
||||
virtual bool OnQuit();
|
||||
|
@@ -56,7 +56,7 @@ public:
|
||||
/**
|
||||
Sets the help controller associated with the dialog.
|
||||
*/
|
||||
void SetController(wxHtmlHelpController* contoller);
|
||||
void SetController(wxHtmlHelpController* controller);
|
||||
|
||||
/**
|
||||
Sets the dialog's title format.
|
||||
|
@@ -59,7 +59,7 @@ public:
|
||||
/**
|
||||
Sets the help controller associated with the frame.
|
||||
*/
|
||||
void SetController(wxHtmlHelpController* contoller);
|
||||
void SetController(wxHtmlHelpController* controller);
|
||||
|
||||
/**
|
||||
Sets the frame's title format.
|
||||
|
@@ -12,7 +12,7 @@
|
||||
This class has been rewritten to be type safe and to provide the full API of
|
||||
the STL std::list container and should be used like it.
|
||||
The exception is that wxList<T> actually stores pointers and therefore its
|
||||
iterators return pointers and not references to the actual objets in the list
|
||||
iterators return pointers and not references to the actual objects in the list
|
||||
(see example below) and @e value_type is defined as @e T*.
|
||||
wxList<T> destroys an object after removing it only if wxList<T>::DeleteContents
|
||||
has been called.
|
||||
@@ -132,7 +132,7 @@ public:
|
||||
void DeleteContents(bool destroy);
|
||||
|
||||
/**
|
||||
Deletes the given element refered to by @a iter from the list
|
||||
Deletes the given element referred to by @a iter from the list
|
||||
if @a iter is a valid iterator. Returns @true if successful.
|
||||
|
||||
Deletes the actual object if DeleteContents( @true ) was called previously.
|
||||
@@ -148,9 +148,9 @@ public:
|
||||
bool DeleteObject(T* object);
|
||||
|
||||
/**
|
||||
Removes element refered to be @a iter.
|
||||
Removes element referred to be @a iter.
|
||||
|
||||
Deletes the actualy object if DeleteContents( @true ) was called previously.
|
||||
Deletes the actual object if DeleteContents( @true ) was called previously.
|
||||
*/
|
||||
void Erase(const compatibility_iterator& iter);
|
||||
|
||||
@@ -192,7 +192,7 @@ public:
|
||||
T* object);
|
||||
|
||||
/**
|
||||
Inserts @a object before the object refered to be @a iter.
|
||||
Inserts @a object before the object referred to be @a iter.
|
||||
*/
|
||||
wxList<T>::compatibility_iterator Insert(compatibility_iterator iter,
|
||||
T* object);
|
||||
|
@@ -575,7 +575,7 @@ public:
|
||||
coordinates, of the given subitem, i.e. the part of the row @a item in the
|
||||
column @a subItem.
|
||||
|
||||
This method is only meaningfull when the wxListCtrl is in the report mode.
|
||||
This method is only meaningful when the wxListCtrl is in the report mode.
|
||||
If @a subItem parameter is equal to the special value
|
||||
@c wxLIST_GETSUBITEMRECT_WHOLEITEM the return value is the same as
|
||||
for GetItemRect().
|
||||
|
@@ -747,7 +747,7 @@ public:
|
||||
Note that the latter must be called the same number of times as the former
|
||||
to undo it, i.e. if you call Suspend() twice you must call Resume() twice as well.
|
||||
|
||||
Note that suspending the logging means that the log sink won't be be flushed
|
||||
Note that suspending the logging means that the log sink won't be flushed
|
||||
periodically, it doesn't have any effect if the current log target does the
|
||||
logging immediately without waiting for Flush() to be called (the standard
|
||||
GUI log target only shows the log dialog when it is flushed, so Suspend()
|
||||
@@ -869,7 +869,7 @@ public:
|
||||
/**
|
||||
Sets the timestamp format prepended by the default log targets to all
|
||||
messages. The string may contain any normal characters as well as %
|
||||
prefixed format specificators, see @e strftime() manual for details.
|
||||
prefixed format specifiers, see @e strftime() manual for details.
|
||||
Passing an empty string to this function disables message time stamping.
|
||||
*/
|
||||
static void SetTimestamp(const wxString& format);
|
||||
|
@@ -349,7 +349,7 @@ public:
|
||||
/**
|
||||
Sets the label associated with the menu item.
|
||||
|
||||
Note that if the ID of this menu item corrisponds to a stock ID, then it is
|
||||
Note that if the ID of this menu item corresponds to a stock ID, then it is
|
||||
not necessary to specify a label: wxWidgets will automatically use the stock
|
||||
item label associated with that ID. See the @ref wxMenuItem::wxMenuItem "constructor"
|
||||
for more info.
|
||||
|
@@ -35,7 +35,7 @@
|
||||
@style{wxSYSTEM_MENU}
|
||||
Displays a system menu (Windows and Motif only).
|
||||
@style{wxRESIZE_BORDER}
|
||||
Displays a resizeable border around the window.
|
||||
Displays a resizable border around the window.
|
||||
@endStyleTable
|
||||
|
||||
@remarks
|
||||
|
@@ -747,14 +747,14 @@ public:
|
||||
void MapScreenSizeToDevice();
|
||||
|
||||
/**
|
||||
This sets the user scale of the wxDC assocated with this wxPrintout to the same
|
||||
This sets the user scale of the wxDC associated with this wxPrintout to the same
|
||||
scale as MapScreenSizeToPaper() but sets the logical origin to the top left corner
|
||||
of the page rectangle.
|
||||
*/
|
||||
void MapScreenSizeToPage();
|
||||
|
||||
/**
|
||||
This sets the user scale of the wxDC assocated with this wxPrintout to the same
|
||||
This sets the user scale of the wxDC associated with this wxPrintout to the same
|
||||
scale as MapScreenSizeToPageMargins() but sets the logical origin to the top left
|
||||
corner of the page margins specified by the given wxPageSetupDialogData object.
|
||||
*/
|
||||
|
@@ -169,7 +169,7 @@ public:
|
||||
wxInputStream* GetInputStream() const;
|
||||
|
||||
/**
|
||||
It returns an output stream correspoding to the input stream of the subprocess.
|
||||
It returns an output stream corresponding to the input stream of the subprocess.
|
||||
|
||||
If it is @NULL, you have not turned on the redirection or already
|
||||
called CloseOutput().
|
||||
|
@@ -720,7 +720,7 @@ public:
|
||||
/**
|
||||
Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER
|
||||
window style needs to be used to indicate that columns are auto-
|
||||
resizeable.
|
||||
resizable.
|
||||
|
||||
@returns Returns @false on failure.
|
||||
|
||||
|
@@ -202,7 +202,7 @@ public:
|
||||
|
||||
//@{
|
||||
/**
|
||||
Data Access: Access to invidividual colour components.
|
||||
Data Access: Access to individual colour components.
|
||||
*/
|
||||
ChannelType& Red();
|
||||
ChannelType& Green();
|
||||
|
@@ -106,7 +106,7 @@ public:
|
||||
|
||||
/**
|
||||
If sizing is not continuous, then return a suitable size for the control
|
||||
which is larger then the current size.
|
||||
which is larger than the current size.
|
||||
|
||||
@param direction
|
||||
The direction(s) in which the size should increase.
|
||||
@@ -121,7 +121,7 @@ public:
|
||||
|
||||
/**
|
||||
If sizing is not continuous, then return a suitable size for the control
|
||||
which is larger then the given size.
|
||||
which is larger than the given size.
|
||||
|
||||
@param direction
|
||||
The direction(s) in which the size should increase.
|
||||
|
@@ -141,9 +141,9 @@ public:
|
||||
Show the panel externally expanded.
|
||||
|
||||
When a panel is minimised, it can be shown full-size in a pop-out
|
||||
window, which is refered to as being (externally) expanded. Note that
|
||||
window, which is referred to as being (externally) expanded. Note that
|
||||
when a panel is expanded, there exist two panels - the original panel
|
||||
(which is refered to as the dummy panel) and the expanded panel. The
|
||||
(which is referred to as the dummy panel) and the expanded panel. The
|
||||
original is termed a dummy as it sits in the ribbon bar doing nothing,
|
||||
while the expanded panel holds the panel children.
|
||||
|
||||
|
@@ -32,7 +32,7 @@ enum wxScrollbarVisibility
|
||||
|
||||
- ::wxScrolledCanvas, aka wxScrolled<wxWindow>, derives from wxWindow and
|
||||
so doesn't handle children specially. This is suitable e.g. for
|
||||
implementating scrollable controls such as tree or list controls.
|
||||
implementing scrollable controls such as tree or list controls.
|
||||
|
||||
Starting from version 2.4 of wxWidgets, there are several ways to use a
|
||||
::wxScrolledWindow (and now wxScrolled). In particular, there are
|
||||
|
@@ -75,7 +75,7 @@ enum wxSystemColour
|
||||
wxSYS_COLOUR_3DLIGHT, //!< Light colour for three-dimensional display elements.
|
||||
wxSYS_COLOUR_INFOTEXT, //!< Text colour for tooltip controls.
|
||||
wxSYS_COLOUR_INFOBK, //!< Background colour for tooltip controls.
|
||||
wxSYS_COLOUR_LISTBOX, //!< Background colour for list-like contols.
|
||||
wxSYS_COLOUR_LISTBOX, //!< Background colour for list-like controls.
|
||||
wxSYS_COLOUR_HOTLIGHT, //!< Colour for a hyperlink or hot-tracked item.
|
||||
|
||||
/**
|
||||
@@ -136,7 +136,7 @@ enum wxSystemColour
|
||||
//!< Synonym for @c wxSYS_COLOUR_BTNHIGHLIGHT.
|
||||
|
||||
/**
|
||||
Synonim for @c wxSYS_COLOUR_BTNFACE.
|
||||
Synonym for @c wxSYS_COLOUR_BTNFACE.
|
||||
|
||||
On wxMSW this colour should be used as the background colour of
|
||||
wxFrames which are used as containers of controls; this is in fact the
|
||||
@@ -273,7 +273,7 @@ public:
|
||||
The value of @a win determines if the metric returned is a global value or
|
||||
a wxWindow based value, in which case it might determine the widget, the
|
||||
display the window is on, or something similar. The window given should be as
|
||||
close to the metric as possible (e.g a wxTopLevelWindow in case of the
|
||||
close to the metric as possible (e.g. a wxTopLevelWindow in case of the
|
||||
wxSYS_CAPTION_Y metric).
|
||||
|
||||
@a index can be one of the ::wxSystemMetric enum values.
|
||||
|
@@ -41,7 +41,7 @@
|
||||
@style{wxSL_SELRANGE}
|
||||
Allows the user to select a range on the slider. Windows only.
|
||||
@style{wxSL_INVERSE}
|
||||
Inverses the mininum and maximum endpoints on the slider. Not
|
||||
Inverses the minimum and maximum endpoints on the slider. Not
|
||||
compatible with wxSL_SELRANGE.
|
||||
@endStyleTable
|
||||
|
||||
|
@@ -14,7 +14,7 @@
|
||||
|
||||
The line may be only vertical or horizontal. Moreover, not all ports
|
||||
(notably not wxGTK) support specifying the transversal direction of the
|
||||
line (e.g. height for a horizontal line) so for maximial portability you
|
||||
line (e.g. height for a horizontal line) so for maximal portability you
|
||||
should specify it as wxDefaultCoord.
|
||||
|
||||
@beginStyleTable
|
||||
|
@@ -277,7 +277,7 @@ public:
|
||||
/**
|
||||
@deprecated This function is deprecated, please use ToWChar() instead.
|
||||
|
||||
Converts from a string @a in in multibyte encoding to Unicode putting up to
|
||||
Converts from a string @a in multibyte encoding to Unicode putting up to
|
||||
@a outLen characters into the buffer @e out.
|
||||
|
||||
If @a out is @NULL, only the length of the string which would result
|
||||
|
@@ -589,7 +589,7 @@ public:
|
||||
|
||||
/**
|
||||
Reads the specified amount of bytes and stores the data in buffer.
|
||||
To check if the call was successfull you must use LastRead() to check
|
||||
To check if the call was successful you must use LastRead() to check
|
||||
if this call did actually read @a size bytes (if it didn't, GetLastError()
|
||||
should return a meaningful value).
|
||||
|
||||
|
@@ -46,7 +46,7 @@
|
||||
@flag{no-maskblt}
|
||||
1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible.
|
||||
Default: 0. In some circumstances the MaskBlt function can be slower than using
|
||||
the fallback code, especially if using DC cacheing. By default, MaskBlt will be
|
||||
the fallback code, especially if using DC caching. By default, MaskBlt will be
|
||||
used where it is implemented by the operating system and driver.
|
||||
@flag{msw.remap}
|
||||
If 1 (the default), wxToolBar bitmap colours will be remapped to the current
|
||||
@@ -117,7 +117,7 @@
|
||||
Also known as wxWINDOW_DEFAULT_VARIANT.
|
||||
@flag{mac.listctrl.always_use_generic}
|
||||
Tells wxListCtrl to use the generic control even when it is capable of
|
||||
using the native control instead. Also knwon as wxMAC_ALWAYS_USE_GENERIC_LISTCTRL.
|
||||
using the native control instead. Also known as wxMAC_ALWAYS_USE_GENERIC_LISTCTRL.
|
||||
@flag{mac.textcontrol-use-spell-checker}
|
||||
This option only has effect for Mac OS X 10.4 and higher.
|
||||
If 1 activates the spell checking in wxTextCtrl.
|
||||
|
@@ -796,7 +796,7 @@ public:
|
||||
void SetTabs(const wxArrayInt& tabs);
|
||||
|
||||
/**
|
||||
Sets the text foreground colout.
|
||||
Sets the text foreground colour.
|
||||
*/
|
||||
void SetTextColour(const wxColour& colText);
|
||||
|
||||
|
@@ -445,7 +445,7 @@ public:
|
||||
|
||||
@param alpha
|
||||
Determines how opaque or transparent the window will be, if the
|
||||
platform supports the opreration. A value of 0 sets the window to be
|
||||
platform supports the operation. A value of 0 sets the window to be
|
||||
fully transparent, and a value of 255 sets the window to be fully
|
||||
opaque.
|
||||
*/
|
||||
|
@@ -15,7 +15,7 @@
|
||||
wxTreeItemId handles, which may be tested for validity by calling
|
||||
wxTreeItemId::IsOk().
|
||||
|
||||
A similar control with a fully native implemtation for GTK+ and OS X
|
||||
A similar control with a fully native implementation for GTK+ and OS X
|
||||
as well is wxDataViewTreeCtrl.
|
||||
|
||||
To intercept events from a tree control, use the event table macros
|
||||
|
@@ -94,7 +94,7 @@ public:
|
||||
y start coordinate, in screen coordinates.
|
||||
|
||||
@param x2
|
||||
x desintation coordinate, in screen coordinates.
|
||||
x destination coordinate, in screen coordinates.
|
||||
|
||||
@param y2
|
||||
y destination coordinate, in screen coordinates.
|
||||
|
@@ -14,7 +14,7 @@
|
||||
each character is stored using a 32-bit value. This is different from
|
||||
wxString which may store a character either as a UTF-8 or as a UTF-16
|
||||
sequence and different from @c std::string which stores a string
|
||||
as a squence of simple 8-bit charactesr and also different from
|
||||
as a sequence of simple 8-bit characters and also different from
|
||||
@c std::wstring which stores the string differently depending on
|
||||
the definition of wchar_t.
|
||||
|
||||
@@ -151,35 +151,35 @@ public:
|
||||
|
||||
|
||||
/**
|
||||
Assigment from a 7-bit ASCII string literal
|
||||
Assignment from a 7-bit ASCII string literal
|
||||
*/
|
||||
wxUString &assignFromAscii( const char *str );
|
||||
/**
|
||||
Assigment from a 7-bit ASCII string literal
|
||||
Assignment from a 7-bit ASCII string literal
|
||||
*/
|
||||
wxUString &assignFromAscii( const char *str, size_t n );
|
||||
/**
|
||||
Assigment from a UTF-8 string literal
|
||||
Assignment from a UTF-8 string literal
|
||||
*/
|
||||
wxUString &assignFromUTF8( const char *str );
|
||||
/**
|
||||
Assigment from a UTF-8 string literal
|
||||
Assignment from a UTF-8 string literal
|
||||
*/
|
||||
wxUString &assignFromUTF8( const char *str, size_t n );
|
||||
/**
|
||||
Assigment from a UTF-16 string literal
|
||||
Assignment from a UTF-16 string literal
|
||||
*/
|
||||
wxUString &assignFromUTF16( const wxChar16* str );
|
||||
/**
|
||||
Assigment from a UTF-16 string literal
|
||||
Assignment from a UTF-16 string literal
|
||||
*/
|
||||
wxUString &assignFromUTF16( const wxChar16* str, size_t n );
|
||||
/**
|
||||
Assigment from a C string literal using wxConvLibc
|
||||
Assignment from a C string literal using wxConvLibc
|
||||
*/
|
||||
wxUString &assignFromCString( const char* str );
|
||||
/**
|
||||
Assigment from a C string literal using @a conv
|
||||
Assignment from a C string literal using @a conv
|
||||
*/
|
||||
wxUString &assignFromCString( const char* str, const wxMBConv &conv );
|
||||
|
||||
|
@@ -711,7 +711,7 @@ wxString wxGetOsDescription();
|
||||
'uname -r' command); e.g. "2" and "6" if the machine is using kernel 2.6.19.
|
||||
|
||||
For Mac OS X systems (@c wxOS_MAC) the major and minor version integers are the
|
||||
natural version numbers associated with the OS; e.g. "10" and and "6" if the machine
|
||||
natural version numbers associated with the OS; e.g. "10" and "6" if the machine
|
||||
is using Mac OS X Snow Leopard.
|
||||
|
||||
For Windows-like systems (@c wxOS_WINDOWS) the major and minor version integers will
|
||||
|
@@ -77,7 +77,7 @@ public:
|
||||
wxVector(size_type size, const value_type& value);
|
||||
|
||||
/**
|
||||
Copy onstructor.
|
||||
Copy constructor.
|
||||
*/
|
||||
wxVector(const wxVector<T>& c);
|
||||
|
||||
|
@@ -715,7 +715,7 @@ public:
|
||||
const wxString& name = wxPanelNameStr);
|
||||
|
||||
/**
|
||||
Same as the non-default constuctor, but returns a status code: @true if
|
||||
Same as the non-default constructor, but returns a status code: @true if
|
||||
ok, @false if the window couldn't be created.
|
||||
|
||||
Just as with the constructor, the @c wxVSCROLL style is always used,
|
||||
@@ -791,7 +791,7 @@ public:
|
||||
const wxString& name = wxPanelNameStr);
|
||||
|
||||
/**
|
||||
Same as the non-default constuctor, but returns a status code: @true if
|
||||
Same as the non-default constructor, but returns a status code: @true if
|
||||
ok, @false if the window couldn't be created.
|
||||
|
||||
Just as with the constructor, the @c wxHSCROLL style is always used,
|
||||
@@ -868,7 +868,7 @@ public:
|
||||
const wxString& name = wxPanelNameStr);
|
||||
|
||||
/**
|
||||
Same as the non-default constuctor, but returns a status code: @true if
|
||||
Same as the non-default constructor, but returns a status code: @true if
|
||||
ok, @false if the window couldn't be created.
|
||||
|
||||
Just as with the constructor, the @c wxHSCROLL and @c wxVSCROLL styles
|
||||
|
@@ -491,7 +491,7 @@ public:
|
||||
*/
|
||||
wxWindow* GetPrevSibling() const;
|
||||
/**
|
||||
Reparents the window, i.e the window will be removed from its
|
||||
Reparents the window, i.e. the window will be removed from its
|
||||
current parent window (e.g. a non-standard toolbar in a wxFrame)
|
||||
and then re-inserted into another.
|
||||
|
||||
@@ -2083,7 +2083,7 @@ public:
|
||||
|
||||
/**
|
||||
Sets the style of the window. Please note that some styles cannot be changed
|
||||
after the window creation and that Refresh() might need to be be called
|
||||
after the window creation and that Refresh() might need to be called
|
||||
after changing the others for the change to take place immediately.
|
||||
|
||||
See @ref overview_windowstyles "Window styles" for more information about flags.
|
||||
@@ -2787,7 +2787,7 @@ public:
|
||||
|
||||
|
||||
/**
|
||||
@name Constraints, sizers and window layouting functions
|
||||
@name Constraints, sizers and window layout functions
|
||||
*/
|
||||
//@{
|
||||
|
||||
@@ -2830,7 +2830,7 @@ public:
|
||||
This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial
|
||||
window size to the size needed to accommodate all sizer elements and sets the
|
||||
size hints which, if this window is a top level one, prevent the user from
|
||||
resizing it to be less than this minimial size.
|
||||
resizing it to be less than this minimal size.
|
||||
*/
|
||||
void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true);
|
||||
|
||||
|
@@ -495,7 +495,7 @@ public:
|
||||
Also, the wizard will never be smaller than the default size.
|
||||
|
||||
The recommended way to use this function is to lay out all wizard pages
|
||||
using the sizers (even though the wizard is not resizeable) and then use
|
||||
using the sizers (even though the wizard is not resizable) and then use
|
||||
wxSizer::CalcMin() in a loop to calculate the maximum of minimal sizes of
|
||||
the pages and pass it to SetPageSize().
|
||||
*/
|
||||
|
Reference in New Issue
Block a user