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

Remove all trailing spaces

Browse Source 
No real changes, just clean up sources by removing trailing spaces from
all the non-generated files.

This should hopefully avoid future commits mixing significant changes
with insignificant whitespace ones.
This commit is contained in:
Vadim Zeitlin
2019-01-30 17:28:08 +01:00
parent ae94f4da9c
commit 8fbca5cb70
320 changed files with 1611 additions and 1611 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
interface/wx/aboutdlg.h
View File

@@ -28,7 +28,7 @@
don't support URLs, licence text nor custom icons in the about dialog and if
either of those is used, wxAboutBox() will automatically use the generic version
so you should avoid specifying these fields to achieve more native look and feel.
Example of usage:
@code
void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
@@ -170,7 +170,7 @@ public:
Returns the icon set by SetIcon().
*/
wxIcon GetIcon() const;
/**
Set the icon to be shown in the dialog. By default the icon of the main frame
will be shown if the native about dialog supports custom icons. If it doesn't
@@ -241,7 +241,7 @@ public:
@see SetVersion()
*/
const wxString& GetVersion() const;
/**
Return the long version string if set.
@@ -263,7 +263,7 @@ public:
Returns the description of the website URL set for the dialog.
*/
const wxString& GetWebSiteDescription() const;
/**
Set the web site for the program and its description (which defaults to @a url
itself if empty).
@@ -275,7 +275,7 @@ public:
void SetWebSite(const wxString& url,
const wxString& desc = wxEmptyString);
/**
Returns @true if developers have been set in the dialog info.
*/
@@ -316,7 +316,7 @@ public:
*/
const wxArrayString& GetTranslators() const;
};

4
interface/wx/affinematrix2dbase.h
View File

@@ -36,7 +36,7 @@ struct wxMatrix2D
/**
@class wxAffineMatrix2DBase
A 2x3 matrix representing an affine 2D transformation.
This is an abstract base class implemented by wxAffineMatrix2D only so far,
@@ -160,7 +160,7 @@ public:
@param cRadians
Rotation angle in radians, clockwise.
*/
*/
virtual void Rotate(wxDouble cRadians) = 0;
/**

2
interface/wx/animate.h
View File

@@ -206,7 +206,7 @@ public:
Default ctor.
*/
wxAnimation();
/**
Copy ctor.
*/

4
interface/wx/anybutton.h
View File

@@ -91,7 +91,7 @@ public:
*/
wxBitmap GetBitmapPressed() const;
/**
Sets the bitmap to display in the button.
@@ -177,7 +177,7 @@ public:
previous versions)
*/
void SetBitmapPressed(const wxBitmap& bitmap);
/**
Get the margins between the bitmap and the text of the button.

2
interface/wx/app.h
View File

@@ -1063,7 +1063,7 @@ public:
is specified in the @c Info.plist file.
@onlyfor{wxosx}
@since 3.0.1
*/
virtual bool OSXIsGUIApplication();

108
interface/wx/artprov.h
View File

@@ -29,64 +29,64 @@ wxArtClient wxART_LIST;
wxArtClient wxART_OTHER;
wxArtID wxART_ADD_BOOKMARK;
wxArtID wxART_DEL_BOOKMARK;
wxArtID wxART_HELP_SIDE_PANEL;
wxArtID wxART_HELP_SETTINGS;
wxArtID wxART_HELP_BOOK;
wxArtID wxART_HELP_FOLDER;
wxArtID wxART_HELP_PAGE;
wxArtID wxART_GO_BACK;
wxArtID wxART_GO_FORWARD;
wxArtID wxART_GO_UP;
wxArtID wxART_GO_DOWN;
wxArtID wxART_GO_TO_PARENT;
wxArtID wxART_GO_HOME;
wxArtID wxART_GOTO_FIRST;
wxArtID wxART_GOTO_LAST;
wxArtID wxART_FILE_OPEN;
wxArtID wxART_FILE_SAVE;
wxArtID wxART_FILE_SAVE_AS;
wxArtID wxART_PRINT;
wxArtID wxART_HELP;
wxArtID wxART_TIP;
wxArtID wxART_REPORT_VIEW;
wxArtID wxART_LIST_VIEW;
wxArtID wxART_NEW_DIR;
wxArtID wxART_HARDDISK;
wxArtID wxART_FLOPPY;
wxArtID wxART_CDROM;
wxArtID wxART_REMOVABLE;
wxArtID wxART_FOLDER;
wxArtID wxART_FOLDER_OPEN;
wxArtID wxART_GO_DIR_UP;
wxArtID wxART_EXECUTABLE_FILE;
wxArtID wxART_NORMAL_FILE;
wxArtID wxART_TICK_MARK;
wxArtID wxART_CROSS_MARK;
wxArtID wxART_ERROR;
wxArtID wxART_QUESTION;
wxArtID wxART_WARNING;
wxArtID wxART_INFORMATION;
wxArtID wxART_MISSING_IMAGE;
wxArtID wxART_ADD_BOOKMARK;
wxArtID wxART_DEL_BOOKMARK;
wxArtID wxART_HELP_SIDE_PANEL;
wxArtID wxART_HELP_SETTINGS;
wxArtID wxART_HELP_BOOK;
wxArtID wxART_HELP_FOLDER;
wxArtID wxART_HELP_PAGE;
wxArtID wxART_GO_BACK;
wxArtID wxART_GO_FORWARD;
wxArtID wxART_GO_UP;
wxArtID wxART_GO_DOWN;
wxArtID wxART_GO_TO_PARENT;
wxArtID wxART_GO_HOME;
wxArtID wxART_GOTO_FIRST;
wxArtID wxART_GOTO_LAST;
wxArtID wxART_FILE_OPEN;
wxArtID wxART_FILE_SAVE;
wxArtID wxART_FILE_SAVE_AS;
wxArtID wxART_PRINT;
wxArtID wxART_HELP;
wxArtID wxART_TIP;
wxArtID wxART_REPORT_VIEW;
wxArtID wxART_LIST_VIEW;
wxArtID wxART_NEW_DIR;
wxArtID wxART_HARDDISK;
wxArtID wxART_FLOPPY;
wxArtID wxART_CDROM;
wxArtID wxART_REMOVABLE;
wxArtID wxART_FOLDER;
wxArtID wxART_FOLDER_OPEN;
wxArtID wxART_GO_DIR_UP;
wxArtID wxART_EXECUTABLE_FILE;
wxArtID wxART_NORMAL_FILE;
wxArtID wxART_TICK_MARK;
wxArtID wxART_CROSS_MARK;
wxArtID wxART_ERROR;
wxArtID wxART_QUESTION;
wxArtID wxART_WARNING;
wxArtID wxART_INFORMATION;
wxArtID wxART_MISSING_IMAGE;
wxArtID wxART_COPY;
wxArtID wxART_CUT;
wxArtID wxART_PASTE;
wxArtID wxART_DELETE;
wxArtID wxART_NEW;
wxArtID wxART_COPY;
wxArtID wxART_CUT;
wxArtID wxART_PASTE;
wxArtID wxART_DELETE;
wxArtID wxART_NEW;
wxArtID wxART_UNDO;
wxArtID wxART_REDO;
wxArtID wxART_UNDO;
wxArtID wxART_REDO;
wxArtID wxART_PLUS;
wxArtID wxART_MINUS;
wxArtID wxART_PLUS;
wxArtID wxART_MINUS;
wxArtID wxART_CLOSE;
wxArtID wxART_QUIT;
wxArtID wxART_CLOSE;
wxArtID wxART_QUIT;
wxArtID wxART_FIND;
wxArtID wxART_FIND_AND_REPLACE;
wxArtID wxART_FIND;
wxArtID wxART_FIND_AND_REPLACE;
wxArtID wxART_FULL_SCREEN;
wxArtID wxART_EDIT;
@@ -214,7 +214,7 @@ wxArtID wxART_EDIT;
For a list of the GTK+ stock items please refer to the
<a href="http://library.gnome.org/devel/gtk/stable/gtk-Stock-Items.html">GTK+ documentation
page</a>.
It is also possible to load icons from the current icon theme by specifying their name
It is also possible to load icons from the current icon theme by specifying their name
(without extension and directory components).
Icon themes recognized by GTK+ follow the freedesktop.org
<a href="http://freedesktop.org/Standards/icon-theme-spec">Icon Themes specification</a>.

4
interface/wx/aui/auibar.h
View File

@@ -179,11 +179,11 @@ public:
*/
int GetToolId() const;
void SetDropDownClicked(bool c);
void SetClickPoint(const wxPoint& p);
void SetItemRect(const wxRect& r);
void SetToolId(int toolId);
void SetToolId(int toolId);
};
wxEventType wxEVT_AUITOOLBAR_TOOL_DROPDOWN;

26
interface/wx/aui/framemanager.h
View File

@@ -333,12 +333,12 @@ public:
/**
LoadPaneInfo() is similar to LoadPerspective, with the exception that it
only loads information about a single pane.
This method writes the serialized data into the passed pane. Pointers to
UI elements are not modified.
@notice This operation also changes the name in the pane information!
@sa LoadPerspective
@sa SavePaneInfo().
@sa SavePerspective
@@ -347,9 +347,9 @@ public:
/**
Loads a saved perspective.
A perspective is the layout state of an AUI managed window.
All currently existing panes that have an object in "perspective"
with the same name ("equivalent") will receive the layout parameters of the object in
"perspective". Existing panes that do not have an equivalent in "perspective" remain
@@ -358,7 +358,7 @@ public:
@param perspective Serialized layout information of a perspective (excl. pointers to UI elements).
@param update If update is @true, wxAuiManager::Update() is automatically invoked,
thus realizing the specified perspective on screen.
@sa LoadPaneInfo
@sa LoadPerspective
@sa SavePerspective
@@ -384,12 +384,12 @@ public:
/**
SavePaneInfo() is similar to SavePerspective, with the exception that it only
saves information about a single pane.
@param pane Pane whose layout parameters should be serialized.
@return The serialized layout parameters of the pane are returned within
the string. Information about the pointers to UI elements stored
in the pane are not serialized.
@sa LoadPaneInfo
@sa LoadPerspective
@sa SavePerspective
@@ -399,7 +399,7 @@ public:
/**
Saves the entire user interface layout into an encoded wxString, which
can then be stored by the application (probably using wxConfig).
@sa LoadPerspective
@sa LoadPaneInfo
@sa SavePaneInfo
@@ -953,7 +953,7 @@ public:
*/
wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c);
/// name of the pane
wxString name;
@@ -961,7 +961,7 @@ public:
wxString caption;
/// icon of the pane, may be invalid
wxBitmap icon;
wxBitmap icon;
/// window that is in this pane
wxWindow* window;
@@ -1003,12 +1003,12 @@ public:
int dock_proportion;
/// buttons on the pane
wxAuiPaneButtonArray buttons;
wxAuiPaneButtonArray buttons;
/// current rectangle (populated by wxAUI)
wxRect rect;
bool IsValid() const;
bool IsValid() const;
};
@@ -1137,7 +1137,7 @@ public:
bool IsOk() const;
bool IsHorizontal() const;
bool IsVertical() const;
wxAuiPaneInfoPtrArray panes; // array of panes
wxRect rect; // current rectangle
int dock_direction; // dock direction (top, bottom, left, right, center)

2
interface/wx/aui/tabmdi.h
View File

@@ -108,7 +108,7 @@ public:
wxWindowID winid,
const wxString& name);
virtual wxToolBar *GetToolBar() const;
// no maximize etc
virtual void Maximize(bool maximize = true);
virtual void Restore();

2
interface/wx/base64.h
View File

@@ -13,7 +13,7 @@
/** @addtogroup group_funcmacro_misc */
//@{
/**
/**
Elements of this enum specify the possible behaviours of wxBase64Decode
when an invalid character is encountered.
*/

12
interface/wx/bitmap.h
View File

@@ -172,7 +172,7 @@ public:
class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
for bitmaps with an additionally alpha channel).
Note that many wxBitmap functions take a @e type parameter, which is a
Note that many wxBitmap functions take a @e type parameter, which is a
value of the ::wxBitmapType enumeration.
The validity of those values depends however on the platform where your program
is running and from the wxWidgets configuration.
@@ -183,9 +183,9 @@ public:
- wxX11 supports XPM files, XPM data, XBM data;
In addition, wxBitmap can load and save all formats that wxImage can; see wxImage
for more info. Of course, you must have loaded the wxImage handlers
for more info. Of course, you must have loaded the wxImage handlers
(see ::wxInitAllImageHandlers() and wxImage::AddHandler).
Note that all available wxBitmapHandlers for a given wxWidgets port are
Note that all available wxBitmapHandlers for a given wxWidgets port are
automatically loaded at startup so you won't need to use wxBitmap::AddHandler.
More on the difference between wxImage and wxBitmap: wxImage is just a
@@ -386,12 +386,12 @@ public:
@param handler
A new bitmap format handler object. There is usually only one instance
of a given handler class in an application session.
Note that unlike wxImage::AddHandler, there's no documented list of
the wxBitmapHandlers available in wxWidgets.
This is because they are platform-specific and most important, they are
This is because they are platform-specific and most important, they are
all automatically loaded at startup.
If you want to be sure that wxBitmap can load a certain type of image,
you'd better use wxImage::AddHandler.

4
interface/wx/bmpbuttn.h
View File

@@ -62,8 +62,8 @@ public:
Button position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Button size.
If ::wxDefaultSize is specified then the button is sized appropriately
Button size.
If ::wxDefaultSize is specified then the button is sized appropriately
for the bitmap.
@param style
Window style. See wxBitmapButton.

2
interface/wx/button.h
View File

@@ -56,7 +56,7 @@
The position of the image inside the button be configured using
SetBitmapPosition(). By default the image is on the left of the text.
Please also notice that GTK+ uses a global setting called @c gtk-button-images
Please also notice that GTK+ uses a global setting called @c gtk-button-images
to determine if the images should be shown in the buttons
at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no
images will be shown, consistently with the native behaviour.

4
interface/wx/checkbox.h
View File

@@ -91,10 +91,10 @@ public:
@param label
Text to be displayed next to the checkbox.
@param pos
Checkbox position.
Checkbox position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Checkbox size.
Checkbox size.
If ::wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxCheckBox.

2
interface/wx/checklst.h
View File

@@ -49,7 +49,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.

4
interface/wx/choice.h
View File

@@ -51,7 +51,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the choice is sized appropriately.
@param n
Number of strings with which to initialise the choice control.
@@ -172,7 +172,7 @@ public:
virtual void SetColumns(int n = 1);
virtual bool IsSorted() const;
virtual unsigned int GetCount() const ;
virtual int GetSelection() const ;
virtual void SetSelection(int n);

2
interface/wx/choicebk.h
View File

@@ -88,7 +88,7 @@ public:
long style = 0,
const wxString& name = wxEmptyString);
/**
Returns the wxChoice associated with the control.
*/

2
interface/wx/clrpicker.h
View File

@@ -57,7 +57,7 @@ class wxColourPickerCtrl : public wxPickerBase
{
public:
wxColourPickerCtrl();
/**
Initializes the object and calls Create() with all the parameters.
*/

12
interface/wx/colour.h
View File

@@ -86,7 +86,7 @@ public:
A packed RGB value.
*/
wxColour(unsigned long colRGB);
/**
Copy constructor.
*/
@@ -194,8 +194,8 @@ public:
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
(case insensitive) and the HTML-like syntax: @c "#" followed by 6 hexadecimal
wxColourDatabase), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax
(case insensitive) and the HTML-like syntax: @c "#" followed by 6 hexadecimal
digits for red, green, blue components.
Returns @true if the conversion was successful, @false otherwise.
@@ -233,7 +233,7 @@ public:
@since 2.9.0
*/
static void MakeMono(unsigned char* r, unsigned char* g, unsigned char* b, bool on);
/**
Create a disabled (dimmed) colour from (in/out) rgb parameters.
@since 2.9.0
@@ -254,7 +254,7 @@ public:
@since 2.9.0
*/
static void MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b);
/**
Create a grey colour from (in/out) rgb parameters using floating point arithmetic.
Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals
@@ -269,7 +269,7 @@ public:
@since 2.9.0
*/
static unsigned char AlphaBlend(unsigned char fg, unsigned char bg, double alpha);
/**
ChangeLightness() is a utility function that simply darkens
or lightens a color, based on the specified percentage

10
interface/wx/combo.h
View File

@@ -69,10 +69,10 @@ public:
/**
Implement to customize matching of value string to an item container
entry.
@param item
String entered, usually by user or from SetValue() call.
@param trueItem
When item matches an entry, but the entry's string representation
is not exactly the same (case mismatch, for example), then the
@@ -130,7 +130,7 @@ public:
Useful in conjunction with LazyCreate().
*/
bool IsCreated() const;
/**
The derived class may implement this to return @true if it wants to
delay call to Create() until the popup is shown for the first time. It
@@ -386,7 +386,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param style
Window style. See wxComboCtrl.
@@ -450,7 +450,7 @@ public:
*/
void EnablePopupAnimation(bool enable = true);
/**
Returns true if given key combination should toggle the popup.
*/

2
interface/wx/combobox.h
View File

@@ -101,7 +101,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.

34
interface/wx/config.h
View File

@@ -27,9 +27,9 @@ enum
However, usually you don't even need to know the precise nature of the
class you're working with but you would just use the wxConfigBase methods.
This allows you to write the same code regardless of whether you're working
with the registry under Windows or text-based config files under Unix.
To make writing the portable code even easier, wxWidgets provides a typedef
wxConfig which is mapped onto the native wxConfigBase implementation on the
with the registry under Windows or text-based config files under Unix.
To make writing the portable code even easier, wxWidgets provides a typedef
wxConfig which is mapped onto the native wxConfigBase implementation on the
given platform: i.e. wxRegConfig under Windows and wxFileConfig otherwise.
See @ref overview_config for a description of all features of this class.
@@ -253,7 +253,7 @@ enum
@library{wxbase}
@category{cfg}
@see wxConfigPathChanger
*/
class wxConfigBase : public wxObject
@@ -353,7 +353,7 @@ public:
Set current path: if the first character is '/', it is the absolute
path, otherwise it is a relative path. '..' is supported. If @a strPath
doesn't exist, it is created.
@see wxConfigPathChanger
*/
virtual void SetPath(const wxString& strPath) = 0;
@@ -889,7 +889,7 @@ public:
@class wxConfigPathChanger
A handy little class which changes the current path in a wxConfig object and restores it in dtor.
Declaring a local variable of this type, it's possible to work in a specific directory
Declaring a local variable of this type, it's possible to work in a specific directory
and ensure that the path is automatically restored when the function returns.
For example:
@@ -902,13 +902,13 @@ public:
wxString str;
if ( !config->Read("SomeString", &str) ) {
wxLogError("Couldn't read SomeString!");
return false;
return false;
// NOTE: without wxConfigPathChanger it would be easy to forget to
// set the old path back into the wxConfig object before this return!
}
// do something useful with SomeString...
return true; // again: wxConfigPathChanger dtor will restore the original wxConfig path
}
@endcode
@@ -923,21 +923,21 @@ public:
/**
Changes the path of the given wxConfigBase object so that the key @a strEntry is accessible
(for read or write).
In other words, the ctor uses wxConfigBase::SetPath() with everything which precedes the
In other words, the ctor uses wxConfigBase::SetPath() with everything which precedes the
last slash of @a strEntry, so that:
@code
wxConfigPathChanger(wxConfigBase::Get(), "/MyProgram/SomeKeyName");
@endcode
@endcode
has the same effect of:
@code
wxConfigPathChanger(wxConfigBase::Get(), "/MyProgram/");
@endcode
@endcode
*/
wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
/**
Restores the path selected, inside the wxConfig object passed to the ctor, to the path which was
Restores the path selected, inside the wxConfig object passed to the ctor, to the path which was
selected when the wxConfigPathChanger ctor was called.
*/
~wxConfigPathChanger();
@@ -949,9 +949,9 @@ public:
const wxString& Name() const;
/**
This method must be called if the original path inside the wxConfig object
(i.e. the current path at the moment of creation of this wxConfigPathChanger object)
could have been deleted, thus preventing wxConfigPathChanger from restoring the not
This method must be called if the original path inside the wxConfig object
(i.e. the current path at the moment of creation of this wxConfigPathChanger object)
could have been deleted, thus preventing wxConfigPathChanger from restoring the not
existing (any more) path.
If the original path doesn't exist any more, the path will be restored to

8
interface/wx/control.h
View File

@@ -50,7 +50,7 @@ public:
@param style
Control style. For generic window styles, please see wxWindow.
@param validator
Control validator.
Control validator.
@param name
Control name.
*/
@@ -64,7 +64,7 @@ public:
Default constructor to allow 2-phase creation.
*/
wxControl();
bool Create(wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
@@ -332,7 +332,7 @@ public:
public: // static functions
/**
Returns the given @a label string without mnemonics ("&" characters).
*/
@@ -340,7 +340,7 @@ public: // static functions
/**
Returns the given @a str string without mnemonics ("&" characters).
@note This function is identical to GetLabelText() and is provided
mostly for symmetry with EscapeMnemonics().
*/

4
interface/wx/cshelp.h
View File

@@ -257,8 +257,8 @@ public:
Button position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Button size.
If ::wxDefaultSize is specified then the button is sized appropriately
Button size.
If ::wxDefaultSize is specified then the button is sized appropriately
for the question mark bitmap.
@param style
Window style.

6
interface/wx/cursor.h
View File

@@ -138,12 +138,12 @@ public:
(to load a cursor from a .ico icon file) and @c wxBITMAP_TYPE_ANI
(to load a cursor from a .ani icon file).
- under MacOS, it defaults to @c wxBITMAP_TYPE_MACCURSOR_RESOURCE;
when specifying a string resource name, first the color cursors 'crsr'
and then the black/white cursors 'CURS' in the resource chain are scanned
when specifying a string resource name, first the color cursors 'crsr'
and then the black/white cursors 'CURS' in the resource chain are scanned
through. Note that resource forks are deprecated on OS X so this
is only available for legacy reasons and should not be used in
new code.
- under GTK, it defaults to @c wxBITMAP_TYPE_XPM.
- under GTK, it defaults to @c wxBITMAP_TYPE_XPM.
See the wxCursor(const wxImage& image) ctor for more info.
- under X11, it defaults to @c wxBITMAP_TYPE_XPM.
- under Motif, it defaults to @c wxBITMAP_TYPE_XBM.

4
interface/wx/dataobj.h
View File

@@ -791,7 +791,7 @@ public:
@class wxHTMLDataObject
wxHTMLDataObject is used for working with HTML-formatted text.
@library{wxcore}
@category{dnd}
@@ -809,7 +809,7 @@ public:
Returns the HTML string.
*/
virtual wxString GetHTML() const;
/**
Sets the HTML string.
*/

12
interface/wx/dataview.h
View File

@@ -78,10 +78,10 @@
@endcode
A potentially better way to avoid memory leaks is to use wxObjectDataPtr
@code
wxObjectDataPtr<MyMusicModel> musicModel;
wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, wxID_ANY );
musicModel = new MyMusicModel;
m_musicCtrl->AssociateModel( musicModel.get() );
@@ -382,7 +382,7 @@ public:
*/
bool ValueChanged(const wxDataViewItem& item, unsigned int col);
virtual bool IsListModel() const;
virtual bool IsVirtualListModel() const;
@@ -527,7 +527,7 @@ public:
have other reason to use a virtual control.
@see wxDataViewListModel for the API.
@library{wxcore}
@category{dvc}
*/
@@ -2064,7 +2064,7 @@ public:
*/
virtual bool Validate(wxVariant& value);
virtual bool HasEditorCtrl() const;
virtual wxWindow* CreateEditorCtrl(wxWindow * parent,
wxRect labelRect,
@@ -3284,7 +3284,7 @@ public:
Returns true if item is a container.
*/
bool IsContainer( const wxDataViewItem& item );
/**
Calls the same method from wxDataViewTreeStore but uses
an index position in the image list instead of a wxIcon.

2
interface/wx/datectrl.h
View File

@@ -87,7 +87,7 @@ public:
Default constructor.
*/
wxDatePickerCtrl();
/**
Initializes the object and calls Create() with all the parameters.
*/

4
interface/wx/datetime.h
View File

@@ -325,7 +325,7 @@ public:
Copy constructor.
*/
wxDateTime(const wxDateTime& date);
/**
Same as Set().
*/
@@ -387,7 +387,7 @@ public:
@a wxDateTime::Tm structure.
*/
wxDateTime& Set(const Tm& tm);
/**
Sets the date from the so-called Julian Day Number.

44
interface/wx/dc.h
View File

@@ -550,7 +550,7 @@ public:
void DrawRectangle(const wxRect& rect);
/**
Draws the text rotated by @a angle degrees
Draws the text rotated by @a angle degrees
(positive angles are counterclockwise; the full angle is 360 degrees).
Notice that, as with DrawText(), the @a text can contain multiple lines
@@ -980,10 +980,10 @@ public:
int GetBackgroundMode() const;
/**
Gets the current font.
Notice that even although each device context object has some default font
after creation, this method would return a ::wxNullFont initially and only
Gets the current font.
Notice that even although each device context object has some default font
after creation, this method would return a ::wxNullFont initially and only
after calling SetFont() a valid font is returned.
*/
const wxFont& GetFont() const;
@@ -1014,17 +1014,17 @@ public:
/**
@a mode may be one of @c wxPENSTYLE_SOLID and @c wxPENSTYLE_TRANSPARENT.
This setting determines whether text will be drawn with a background
This setting determines whether text will be drawn with a background
colour or not.
*/
void SetBackgroundMode(int mode);
/**
Sets the current font for the DC.
Sets the current font for the DC.
If the argument is ::wxNullFont (or another invalid font; see wxFont::IsOk),
the current font is selected out of the device context (leaving wxDC without
If the argument is ::wxNullFont (or another invalid font; see wxFont::IsOk),
the current font is selected out of the device context (leaving wxDC without
any valid font), allowing the current font to be destroyed safely.
@see wxFont
@@ -1045,9 +1045,9 @@ public:
void SetTextForeground(const wxColour& colour);
/**
Sets the current layout direction for the device context.
@param dir
Sets the current layout direction for the device context.
@param dir
May be either @c wxLayout_Default, @c wxLayout_LeftToRight or
@c wxLayout_RightToLeft.
@@ -1333,8 +1333,8 @@ public:
/**
Sets the current brush for the DC.
If the argument is ::wxNullBrush (or another invalid brush; see wxBrush::IsOk),
the current brush is selected out of the device context (leaving wxDC without
If the argument is ::wxNullBrush (or another invalid brush; see wxBrush::IsOk),
the current brush is selected out of the device context (leaving wxDC without
any valid brush), allowing the current brush to be destroyed safely.
@see wxBrush, wxMemoryDC (for the interpretation of colours when
@@ -1343,10 +1343,10 @@ public:
void SetBrush(const wxBrush& brush);
/**
Sets the current pen for the DC.
Sets the current pen for the DC.
If the argument is ::wxNullPen (or another invalid pen; see wxPen::IsOk),
the current pen is selected out of the device context (leaving wxDC without any
If the argument is ::wxNullPen (or another invalid pen; see wxPen::IsOk),
the current pen is selected out of the device context (leaving wxDC without any
valid pen), allowing the current pen to be destroyed safely.
@see wxMemoryDC for the interpretation of colours when drawing into a
@@ -1592,7 +1592,7 @@ public:
//@}
/**
@name query capabilities
*/
@@ -1607,7 +1607,7 @@ public:
Does the DC support calculating the size required to draw text?
*/
bool CanGetTextExtent() const;
//@}
/**
@@ -1620,12 +1620,12 @@ public:
wxGCDC then the return value will be the value returned from
wxGraphicsContext::GetNativeContext. A value of NULL is returned if
the DC does not have anything that fits the handle concept.
@since 2.9.5
*/
void* GetHandle() const;
/**
If supported by the platform and the type of DC, fetch the contents of the DC, or a subset of it, as a bitmap.
*/

2
interface/wx/dcbuffer.h
View File

@@ -122,7 +122,7 @@ public:
/**
Blits the buffer to the dc, and detaches the dc from the buffer (so it
can be effectively used once only).
Usually only called in the destructor or by the destructor of derived
classes if the BufferedDC must blit before the derived class (which may
own the dc it's blitting to) is destroyed.

2
interface/wx/dcgraph.h
View File

@@ -60,7 +60,7 @@ public:
wxGCDC();
virtual ~wxGCDC();
/**
Retrieves associated wxGraphicsContext
*/

4
interface/wx/debugrpt.h
View File

@@ -221,8 +221,8 @@ public:
is copied to a file in the debug report directory with the same name.
Otherwise the file will be searched in the temporary directory returned
by GetDirectory().
The argument @a description only exists to be displayed to the user in
The argument @a description only exists to be displayed to the user in
the report summary shown by wxDebugReportPreview.
@see GetDirectory(), AddText()

10
interface/wx/defs.h
View File

@@ -536,7 +536,7 @@ enum wxBackgroundStyle
with this style.
*/
wxBG_STYLE_PAINT,
/* this style is deprecated and doesn't do anything, don't use */
wxBG_STYLE_COLOUR,
@@ -907,7 +907,7 @@ enum wxKeyCode
WXK_CONTROL_X,
WXK_CONTROL_Y,
WXK_CONTROL_Z,
WXK_BACK = 8, //!< Backspace.
WXK_TAB = 9,
WXK_RETURN = 13,
@@ -1034,7 +1034,7 @@ enum wxKeyCode
WXK_WINDOWS_LEFT,
WXK_WINDOWS_RIGHT,
WXK_WINDOWS_MENU ,
/** This special key code was used to represent the key used for keyboard shortcuts. Under OS X,
* this key maps to the 'Command' (aka logo or 'Apple') key, whereas on Linux/Windows/others
* this is the Control key, with the new semantic of WXK_CONTROL, WXK_COMMAND is not needed anymore
@@ -1095,11 +1095,11 @@ enum wxKeyModifier
wxMOD_SHIFT = 0x0004,
wxMOD_META = 0x0008,
wxMOD_WIN = wxMOD_META,
/** used to describe the true Ctrl Key under OS X,
identic to @c wxMOD_CONTROL on other platforms */
wxMOD_RAW_CONTROL,
/** deprecated, identic to @c wxMOD_CONTROL on all platforms */
wxMOD_CMD = wxMOD_CONTROL,
wxMOD_ALL = 0xffff

8
interface/wx/dir.h
View File

@@ -233,7 +233,7 @@ public:
would be unchanged and should include ::wxDIR_DIRS flag to recurse into
subdirectories (both flags are included in the value by default).
See ::wxDirFlags for the list of the possible flags.
@return Returns the total number of files found while traversing
the directory @a dirname (i.e. the number of entries appended
to the @a files array).
@@ -324,7 +324,7 @@ public:
/**
Creates a directory.
This is just an alias for wxFileName::Mkdir(); refer to that function
for more info.
*/
@@ -339,12 +339,12 @@ public:
/**
Removes a directory.
This is just an alias for wxFileName::Rmdir(); refer to that function
for more info.
*/
static bool Remove(const wxString &dir, int flags = 0);
/**
Enumerate all files and directories under the given directory.

2
interface/wx/dirctrl.h
View File

@@ -52,7 +52,7 @@ enum
@library{wxcore}
@category{ctrl}
@appearance{genericdirctrl}
@beginEventEmissionTable
@event{EVT_DIRCTRL_SELECTIONCHANGED(id, func)}
Selected directory has changed.

2
interface/wx/editlbox.h
View File

@@ -58,7 +58,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param style
Window style. See wxEditableListBox.

16
interface/wx/event.h
View File

@@ -1867,7 +1867,7 @@ public:
int GetPosition() const;
void SetOrientation(int orient);
void SetPosition(int pos);
void SetPosition(int pos);
};
@@ -3298,7 +3298,7 @@ class wxQueryNewPaletteEvent : public wxEvent
{
public:
wxQueryNewPaletteEvent(wxWindowID winid = 0);
void SetPaletteRealized(bool realized);
bool GetPaletteRealized();
};
@@ -3653,9 +3653,9 @@ public:
*/
int GetPosition() const;
void SetOrientation(int orient);
void SetPosition(int pos);
void SetPosition(int pos);
};
@@ -4179,7 +4179,7 @@ public:
/**
Sets the flags for this event.
The @a flags can be a combination of the
The @a flags can be a combination of the
wxNavigationKeyEvent::wxNavigationKeyEventFlags values.
*/
void SetFlags(long flags);
@@ -4563,7 +4563,7 @@ public:
wxRect GetRect() const;
void SetRect(const wxRect& rect);
void SetPosition(const wxPoint& pos);
void SetPosition(const wxPoint& pos);
};
@@ -4587,7 +4587,7 @@ public:
@b Important : Sizers ( see @ref overview_sizer ) rely on size events to function
correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all
size events you catch (and don't catch size events at all when you don't need to).
@beginEventTable{wxSizeEvent}
@event{EVT_SIZE(func)}
Process a @c wxEVT_SIZE event.
@@ -4844,7 +4844,7 @@ wxEventType wxNewEventType();
In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
to capture events.
Note that this macro requires a final semicolon.
@see @ref overview_events_eventtables

2
interface/wx/evtloop.h
View File

@@ -324,7 +324,7 @@ public:
@class wxGUIEventLoop
A generic implementation of the GUI event loop.
@library{wxbase}
@category{appmanagement}
*/

2
interface/wx/fileconf.h
View File

@@ -105,7 +105,7 @@ public:
@see wxCHANGE_UMASK()
*/
void SetUmask(int mode);
// implement inherited pure virtual functions
virtual void SetPath(const wxString& strPath);
virtual const wxString& GetPath() const;

20
interface/wx/filedlg.h
View File

@@ -48,14 +48,14 @@ const char wxFileSelectorDefaultWildcardStr[];
return;
//else: proceed asking to the user the new file to open
}
wxFileDialog
wxFileDialog
openFileDialog(this, _("Open XYZ file"), "", "",
"XYZ files (*.xyz)|*.xyz", wxFD_OPEN|wxFD_FILE_MUST_EXIST);
if (openFileDialog.ShowModal() == wxID_CANCEL)
return; // the user changed idea...
// proceed loading the file chosen by the user;
// this can be done with e.g. wxWidgets input streams:
wxFileInputStream input_stream(openFileDialog.GetPath());
@@ -64,22 +64,22 @@ const char wxFileSelectorDefaultWildcardStr[];
wxLogError("Cannot open file '%s'.", openFileDialog.GetPath());
return;
}
...
}
@endcode
The typical usage for the save file dialog is instead somewhat simpler:
@code
void MyFrame::OnSaveAs(wxCommandEvent& WXUNUSED(event))
{
wxFileDialog
wxFileDialog
saveFileDialog(this, _("Save XYZ file"), "", "",
"XYZ files (*.xyz)|*.xyz", wxFD_SAVE|wxFD_OVERWRITE_PROMPT);
if (saveFileDialog.ShowModal() == wxID_CANCEL)
return; // the user changed idea...
// save the current contents in the file;
// this can be done with e.g. wxWidgets output streams:
wxFileOutputStream output_stream(saveFileDialog.GetPath());
@@ -88,7 +88,7 @@ const char wxFileSelectorDefaultWildcardStr[];
wxLogError("Cannot save current contents in file '%s'.", saveFileDialog.GetPath());
return;
}
...
}
@endcode
@@ -136,7 +136,7 @@ const char wxFileSelectorDefaultWildcardStr[];
@style{wxFD_MULTIPLE}
For open dialog only: allows selecting multiple files.
@style{wxFD_CHANGE_DIR}
Change the current working directory (when the dialog is dismissed)
Change the current working directory (when the dialog is dismissed)
to the directory where the file(s) chosen by the user are.
@style{wxFD_PREVIEW}
Show the preview of the selected files (currently only supported by
@@ -302,7 +302,7 @@ public:
/**
Sets the default filename.
In wxGTK this will have little effect unless a default directory has previously been set.
*/
virtual void SetFilename(const wxString& setfilename);

4
interface/wx/filepicker.h
View File

@@ -83,7 +83,7 @@ class wxFilePickerCtrl : public wxPickerBase
{
public:
wxFilePickerCtrl();
/**
Initializes the object and calls Create() with
all the parameters.
@@ -237,7 +237,7 @@ class wxDirPickerCtrl : public wxPickerBase
{
public:
wxDirPickerCtrl();
/**
Initializes the object and calls Create() with
all the parameters.

2
interface/wx/filesys.h
View File

@@ -64,7 +64,7 @@ public:
Remove a filesystem handler from the list of handlers.
*/
static wxFileSystemHandler* RemoveHandler(wxFileSystemHandler *handler);
/**
Sets the current location. @a location parameter passed to OpenFile() is
relative to this path.

2
interface/wx/fontpicker.h
View File

@@ -59,7 +59,7 @@ class wxFontPickerCtrl : public wxPickerBase
{
public:
wxFontPickerCtrl();
/**
Initializes the object and calls Create() with
all the parameters.

2
interface/wx/fontutil.h
View File

@@ -8,7 +8,7 @@
/**
@class wxNativeFontInfo
wxNativeFontInfo is platform-specific font representation: this class
should be considered as an opaque font description only used by the native
functions, the user code can only get the objects of this type from

4
interface/wx/gbsizer.h
View File

@@ -82,7 +82,7 @@ public:
//@{
/**
Adds the given item to the given position.
@return A valid pointer if the item was successfully placed at the
given position, or @NULL if something was already there.
*/
@@ -299,7 +299,7 @@ public:
*/
bool SetSpan(const wxGBSpan& span);
wxGridBagSizer* GetGBSizer() const;
void SetGBSizer(wxGridBagSizer* sizer);
};

2
interface/wx/gdicmn.h
View File

@@ -557,7 +557,7 @@ public:
*/
void SetBottomLeft(const wxPoint &p);
//@{
/**
Modifies the rectangle to contain the bounding box of this rectangle

6
interface/wx/generic/helpext.h
View File

@@ -111,9 +111,9 @@ public:
@param k
string to search for, empty string will list all entries
@param mode
optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
@param mode
optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
but this currently only supported by the wxHtmlHelpController.
@return @true on success

2
interface/wx/geometry.h
View File

@@ -279,7 +279,7 @@ public:
void Inset( wxInt32 x , wxInt32 y );
void Inset( wxInt32 left , wxInt32 top ,wxInt32 right , wxInt32 bottom );
void Offset( const wxPoint2DInt &pt );
void ConstrainTo( const wxRect2DInt &rect );
void ConstrainTo( const wxRect2DInt &rect );
wxPoint2DInt Interpolate( wxInt32 widthfactor , wxInt32 heightfactor );
static void Intersect( const wxRect2DInt &src1 , const wxRect2DInt &src2 , wxRect2DInt *dest );

4
interface/wx/headerctrl.h
View File

@@ -692,7 +692,7 @@ public:
*/
int GetColumn() const;
void SetColumn(int col);
/**
Return the current width of the column.
@@ -700,7 +700,7 @@ public:
*/
int GetWidth() const;
void SetWidth(int width);
/**
Return the new order of the column.

2
interface/wx/help.h
View File

@@ -247,7 +247,7 @@ public:
This is an alias for one of a family of help controller classes which is
most appropriate for the current platform.
A help controller allows an application to display help, at the contents
or at a particular topic, and shut the help program down on termination.
This avoids proliferation of many instances of the help viewer whenever the

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

@@ -269,7 +269,7 @@ public:
wxHtmlHelpDialog* GetDialog();
protected:
/**

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

@@ -20,7 +20,7 @@ public:
wxString GetTitle() const;
wxString GetStart() const;
wxString GetBasePath() const;
/* SetContentsRange: store in the bookrecord where in the index/contents lists the
* book's records are stored. This to facilitate searching in a specific book.
* This code will have to be revised when loading/removing books becomes dynamic.

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

@@ -8,7 +8,7 @@
/**
@class wxHtmlRenderingStyle
wxHtmlSelection is data holder with information about text selection.
Selection is defined by two positions (beginning and end of the selection)
and two leaf(!) cells at these positions.

14
interface/wx/html/htmprint.h
View File

@@ -136,15 +136,15 @@ public:
Sets font sizes to be relative to the given size or the system
default size; use either specified or default font
@param size
@param size
Point size of the default HTML text
@param normal_face
This is face name for normal (i.e. non-fixed) font. It can be
either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under
This is face name for normal (i.e. non-fixed) font. It can be
either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under
Unix or "Times New Roman" under Windows.
@param fixed_face
The same thing for fixed face ( \<TT\>..\</TT\> )
The same thing for fixed face ( \<TT\>..\</TT\> )
@see SetSize()
*/
@@ -301,7 +301,7 @@ public:
*/
void SetFonts(const wxString& normal_face, const wxString& fixed_face,
const int* sizes = NULL);
/**
Sets the name used for preview frames and setup dialogs.
@@ -310,7 +310,7 @@ public:
void SetName(const wxString& name);
/**
Sets default font sizes and/or default font size.
Sets default font sizes and/or default font size.
See wxHtmlDCRenderer::SetStandardFonts for detailed description.
@see SetFonts()
*/

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

@@ -35,7 +35,7 @@ public:
const wxSize& size = wxDefaultSize, long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxWebKitCtrlNameStr);
bool Create(wxWindow *parent,
wxWindowID winid,
const wxString& strURL,

2
interface/wx/htmllbox.h
View File

@@ -218,7 +218,7 @@ public:
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Window size.
Window size.
If ::wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.

2
interface/wx/hyperlink.h
View File

@@ -100,7 +100,7 @@ class wxHyperlinkCtrl : public wxControl
{
public:
wxHyperlinkCtrl();
/**
Constructor. See Create() for more info.
*/

4
interface/wx/iconbndl.h
View File

@@ -140,10 +140,10 @@ public:
always returned. Otherwise, the behaviour depends on the flags. If only
wxIconBundle::FALLBACK_NONE is given, the function returns an invalid
icon. If wxIconBundle::FALLBACK_SYSTEM is given, it tries to find the
icon of standard system size, regardless of the size passed as
icon of standard system size, regardless of the size passed as
parameter. Otherwise, or if the icon system size is not found neither,
but wxIconBundle::FALLBACK_NEAREST_LARGER flag is specified, the
function returns the smallest icon of the size larger than the
function returns the smallest icon of the size larger than the
requested one or, if this fails too, just the icon closest to the
specified size.

8
interface/wx/image.h
View File

@@ -350,7 +350,7 @@ protected:
/**
Called to get the number of images available in a multi-image file
type, if supported.
NOTE: this function is allowed to change the current stream position
since GetImageCount() will take care of restoring it later
*/
@@ -358,7 +358,7 @@ protected:
/**
Called to test if this handler can read an image from the given stream.
NOTE: this function is allowed to change the current stream position
since CallDoCanRead() will take care of restoring it later
*/
@@ -512,7 +512,7 @@ public:
double hue;
double saturation;
double value;
double value;
};
/**
@@ -1744,7 +1744,7 @@ public:
/**
Set the color of the pixel at the given x and y coordinate.
*/
void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
/**

16
interface/wx/imaggif.h
View File

@@ -1,9 +1,9 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imaggif.h
// Purpose: interface of wxGIFHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imaggif.h
// Purpose: interface of wxGIFHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
#define wxIMAGE_OPTION_GIF_COMMENT wxT("GifComment")
@@ -25,13 +25,13 @@ public:
*/
wxGIFHandler();
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose = true,
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose = true,
int index = -1);
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
/**
Save the animated gif.
@param images
The image array object which is to be affected by this operation.
@param stream

14
interface/wx/imagiff.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagiff.h
// Purpose: interface of wxIFFHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagiff.h
// Purpose: interface of wxIFFHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxIFFHandler
This is the image handler for the IFF format.

16
interface/wx/imagjpeg.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagjpeg.h
// Purpose: interface of wxJPEGHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagjpeg.h
// Purpose: interface of wxJPEGHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxJPEGHandler
This is the image handler for the JPEG format.
@@ -22,7 +22,7 @@ public:
Default constructor for wxJPEGHandler
*/
wxJPEGHandler();
/**
Retrieve the version information about the JPEG library used by this
handler.

14
interface/wx/imagpcx.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagpcx.h
// Purpose: interface of wxPCXHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagpcx.h
// Purpose: interface of wxPCXHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxPCXHandler
This is the image handler for the PCX format.

12
interface/wx/imagpng.h
View File

@@ -1,9 +1,9 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagpng.h
// Purpose: interface of wxPNGHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagpng.h
// Purpose: interface of wxPNGHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
#define wxIMAGE_OPTION_PNG_FORMAT wxT("PngFormat")
#define wxIMAGE_OPTION_PNG_BITDEPTH wxT("PngBitDepth")

14
interface/wx/imagpnm.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagpnm.h
// Purpose: interface of wxPNMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagpnm.h
// Purpose: interface of wxPNMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxPNMHandler
This is the image handler for the PNM format.

14
interface/wx/imagtga.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagtga.h
// Purpose: interface of wxTGAHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagtga.h
// Purpose: interface of wxTGAHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxTGAHandler
This is the image handler for the TGA format.

12
interface/wx/imagtiff.h
View File

@@ -13,12 +13,12 @@
/**
@class wxTIFFHandler
This is the image handler for the TIFF format.
@library{wxcore}
@category{gdi}
@see wxImage, wxImageHandler, wxInitAllImageHandlers()
*/
class wxTIFFHandler : public wxImageHandler
@@ -28,7 +28,7 @@ public:
Default constructor for wxTIFFHandler
*/
wxTIFFHandler();
/**
Retrieve the version information about the TIFF library used by this
handler.
@@ -36,10 +36,10 @@ public:
@since 2.9.2
*/
static wxVersionInfo GetLibraryVersionInfo();
// let the parent class' (wxImageHandler) documentation through for these methods
virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1);
protected:
virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true);
virtual int DoGetImageCount(wxInputStream& stream);

14
interface/wx/imagxpm.h
View File

@@ -1,11 +1,11 @@
/////////////////////////////////////////////////////////////////////////////
// Name: imagxpm.h
// Purpose: interface of wxXPMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////
// Name: imagxpm.h
// Purpose: interface of wxXPMHandler
// Author: Samuel Dunn
// Licence: wxWindows licence
////////////////////////////////////////////////////////////////////////////
/**
/**
@class wxXPMHandler
This is the image handler for the XPM format.

6
interface/wx/intl.h
View File

@@ -98,15 +98,15 @@ enum wxLocaleCategory
/**
The values understood by wxLocale::GetInfo().
Note that for the @c wxLOCALE_*_FMT constants (the date and time formats),
Note that for the @c wxLOCALE_*_FMT constants (the date and time formats),
the strings returned by wxLocale::GetInfo() use strftime() or,
equivalently, wxDateTime::Format() format. If the relevant format
couldn't be determined, an empty string is returned -- there is no
fallback value so that the application could determine the best course
of actions itself in such case.
All of these values are used with @c wxLOCALE_CAT_DATE in wxLocale::GetInfo() or,
All of these values are used with @c wxLOCALE_CAT_DATE in wxLocale::GetInfo() or,
more typically, with @c wxLOCALE_CAT_DEFAULT as they only apply to a single category.
*/
enum wxLocaleInfo

8
interface/wx/kbdstate.h
View File

@@ -107,9 +107,9 @@ public:
/**
Returns true if the Control key (also under OS X).
This function doesn't distinguish between right and left control keys.
Notice that GetModifiers() should usually be used instead of this one.
*/
bool RawControlDown() const;
@@ -127,7 +127,7 @@ public:
Returns true if the Meta/Windows/Apple key is pressed.
This function tests the state of the key traditionally called Meta
under Unix systems, Windows keys under MSW
under Unix systems, Windows keys under MSW
Notice that GetModifiers() should usually be used instead of this one.
@see CmdDown()
@@ -149,7 +149,7 @@ public:
*/
bool CmdDown() const;
void SetControlDown(bool down);
void SetRawControlDown(bool down);
void SetShiftDown(bool down);

10
interface/wx/listbox.h
View File

@@ -176,9 +176,9 @@ public:
void Deselect(int n);
virtual void SetSelection(int n);
virtual int GetSelection() const;
virtual bool SetStringSelection(const wxString& s, bool select);
virtual bool SetStringSelection(const wxString& s);
@@ -324,8 +324,8 @@ public:
// NOTE: Phoenix needs to see the implementation of pure virtuals so it
// knows that this class is not abstract.
virtual unsigned int GetCount() const;
virtual wxString GetString(unsigned int n) const;
virtual void SetString(unsigned int n, const wxString& s);
virtual int FindString(const wxString& s, bool bCase = false) const;
virtual wxString GetString(unsigned int n) const;
virtual void SetString(unsigned int n, const wxString& s);
virtual int FindString(const wxString& s, bool bCase = false) const;
};

6
interface/wx/listctrl.h
View File

@@ -374,7 +374,7 @@ public:
@return @true if all columns were successfully deleted, @false otherwise.
*/
bool DeleteAllColumns();
/**
Deletes all items in the list control.
@@ -1405,7 +1405,7 @@ protected:
@event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)}
The right mouse button has been clicked on an item.
@event{EVT_LIST_KEY_DOWN(id, func)}
A key has been pressed. GetIndex() may be -1 if no item is selected.
A key has been pressed. GetIndex() may be -1 if no item is selected.
@event{EVT_LIST_INSERT_ITEM(id, func)}
An item has been inserted.
@event{EVT_LIST_COL_CLICK(id, func)}
@@ -1516,7 +1516,7 @@ public:
*/
bool IsEditCancelled() const;
/**
@see GetKeyCode()
*/

6
interface/wx/log.h
View File

@@ -507,7 +507,7 @@ public:
/**
Show all pending output and clear the buffer.
Some of wxLog implementations, most notably the standard wxLogGui class,
buffer the messages (for example, to avoid showing the user a zillion of modal
message boxes one after another -- which would be really annoying).
@@ -1398,8 +1398,8 @@ void wxVLogError(const char* formatString, va_list argPtr);
make sense to separate them from other debug messages.
Trace messages can be separated into different categories; these functions in facts
only log the message if the given @a mask is currently enabled in wxLog.
This lets you selectively trace only some operations and not others by enabling the
only log the message if the given @a mask is currently enabled in wxLog.
This lets you selectively trace only some operations and not others by enabling the
desired trace masks with wxLog::AddTraceMask() or by setting the
@ref overview_envvars "@c WXTRACE environment variable".

2
interface/wx/math.h
View File

@@ -93,7 +93,7 @@ unsigned int wxCTZ(wxUint32 x);
*/
int wxRound(double x);
/**
/**
Returns true if both double values are identical. This is
only reliable if both values have been assigned the same
value.

24
interface/wx/menu.h
View File

@@ -382,27 +382,27 @@ public:
@remarks Use only after the menubar has been associated with a frame.
*/
virtual void SetMenuLabel(size_t pos, const wxString& label);
/**
/**
Enables you to set the global menubar on Mac, that is, the menubar displayed
when the app is running without any frames open.
@param menubar
The menubar to set.
@remarks Only exists on Mac, other platforms do not have this method.
@remarks Only exists on Mac, other platforms do not have this method.
@onlyfor{wxosx}
*/
static void MacSetCommonMenuBar(wxMenuBar* menubar);
/**
/**
Enables you to get the global menubar on Mac, that is, the menubar displayed
when the app is running without any frames open.
@return The global menubar.
@remarks Only exists on Mac, other platforms do not have this method.
@remarks Only exists on Mac, other platforms do not have this method.
@onlyfor{wxosx}
*/
@@ -511,7 +511,7 @@ public:
Constructs a wxMenu object.
*/
wxMenu();
/**
Constructs a wxMenu object.
@@ -1050,7 +1050,7 @@ public:
*/
void UpdateUI(wxEvtHandler* source = NULL);
void SetInvokingWindow(wxWindow *win);
wxWindow *GetInvokingWindow() const;
wxWindow *GetWindow() const;

68
interface/wx/menuitem.h
View File

@@ -144,37 +144,37 @@ public:
@see GetItemLabelText(), GetItemLabel()
*/
static wxString GetLabelText(const wxString& text);
/**
@name Getters
*/
//@{
/**
Returns the background colour associated with the menu item.
@onlyfor{wxmsw}
*/
wxColour& GetBackgroundColour() const;
/**
Returns the checked or unchecked bitmap.
@onlyfor{wxmsw}
*/
virtual const wxBitmap& GetBitmap(bool checked = true) const;
/**
Returns the bitmap to be used for disabled items.
@onlyfor{wxmsw}
*/
virtual const wxBitmap& GetDisabledBitmap() const;
/**
Returns the font associated with the menu item.
@onlyfor{wxmsw}
*/
wxFont& GetFont() const;
@@ -223,7 +223,7 @@ public:
/**
Gets the width of the menu item checkmark bitmap.
@onlyfor{wxmsw}
*/
int GetMarginWidth() const;
@@ -238,7 +238,7 @@ public:
Returns the text associated with the menu item.
@deprecated This function is deprecated. Please use GetItemLabel() or GetItemLabelText() instead.
@see GetItemLabel(), GetItemLabelText()
*/
wxString GetName() const;
@@ -260,11 +260,11 @@ public:
/**
Returns the text colour associated with the menu item.
@onlyfor{wxmsw}
*/
wxColour& GetTextColour() const;
/**
Extract the accelerator from the given menu string, return NULL if none
found.
@@ -277,9 +277,9 @@ public:
virtual wxAcceleratorEntry *GetAccel() const;
//@}
/**
@name Checkers
*/
@@ -329,11 +329,11 @@ public:
Returns @true if the item is a submenu.
*/
bool IsSubMenu() const;
//@}
/**
@name Setters
*/
@@ -341,7 +341,7 @@ public:
/**
Sets the background colour associated with the menu item.
@onlyfor{wxmsw}
*/
void SetBackgroundColour(const wxColour& colour);
@@ -349,7 +349,7 @@ public:
/**
Sets the bitmap for the menu item.
It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if
It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if
@a checked is @true (default value) or SetBitmaps(wxNullBitmap, bmp)
otherwise.
@@ -386,7 +386,7 @@ public:
/**
Sets the font associated with the menu item.
@onlyfor{wxmsw}
*/
void SetFont(const wxFont& font);
@@ -398,19 +398,19 @@ public:
/**
Sets the label associated with the menu item.
Note that if the ID of this menu item corresponds 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.
The label string for the normal menu items (not separators) may include the
The label string for the normal menu items (not separators) may include the
accelerator which can be used to activate the menu item from keyboard.
An accelerator key can be specified using the ampersand <tt>&</tt> character.
In order to embed an ampersand character in the menu item text, the ampersand
An accelerator key can be specified using the ampersand <tt>&</tt> character.
In order to embed an ampersand character in the menu item text, the ampersand
must be doubled.
Optionally you can specify also an accelerator string appending a tab character
Optionally you can specify also an accelerator string appending a tab character
<tt>\\t</tt> followed by a valid key combination (e.g. <tt>CTRL+V</tt>).
Its general syntax is any combination of @c "CTRL", @c "RAWCTRL", @c
"ALT" and @c "SHIFT" strings (case doesn't matter) separated by either
@@ -507,7 +507,7 @@ public:
/**
Sets the width of the menu item checkmark bitmap.
@onlyfor{wxmsw}
*/
void SetMarginWidth(int width);
@@ -526,18 +526,18 @@ public:
Sets the text associated with the menu item.
@deprecated This function is deprecated in favour of SetItemLabel().
@see SetItemLabel().
*/
virtual void SetText(const wxString& text);
/**
Sets the text colour associated with the menu item.
@onlyfor{wxmsw}
*/
void SetTextColour(const wxColour& colour);
/**
Set the accel for this item - this may also be done indirectly with
SetText()

20
interface/wx/mimetype.h
View File

@@ -10,11 +10,11 @@
This class allows the application to retrieve information about all known
MIME types from a system-specific location and the filename extensions to the
MIME types and vice versa.
MIME types and vice versa.
MIME stands for "Multipurpose Internet Mail Extensions" and was originally
used in mail protocols. It's standardized by several RFCs.
Under Windows, the MIME type information is queried from registry.
Under Linux and Unix, it is queried from the XDG data directories.
@@ -23,7 +23,7 @@
The application should not construct its own manager: it should use the
object pointer ::wxTheMimeTypesManager.
The functions GetFileTypeFromMimeType() and GetFileTypeFromExtension()
return a wxFileType object which may be further queried for file description,
return a wxFileType object which may be further queried for file description,
icon and other attributes.
@section mimetypemanager_helpers Helper functions
@@ -445,7 +445,7 @@ public:
const wxString& description,
const wxString& extension,
...);
/**
Constructor using an array of string elements corresponding to the
parameters of the ctor above in the same order.
@@ -497,7 +497,7 @@ public:
Get the MIME type
*/
const wxString& GetMimeType() const;
/**
Get the open command
*/
@@ -507,17 +507,17 @@ public:
Get the print command
*/
const wxString& GetPrintCommand() const;
/**
Get the short description (only used under Win32 so far)
*/
const wxString& GetShortDesc() const;
/**
Get the long, user visible description
*/
const wxString& GetDescription() const;
/**
Get the array of all extensions
*/
@@ -527,7 +527,7 @@ public:
Get the number of extensions.
*/
size_t GetExtensionsCount() const;
/**
Get the icon filename
*/

4
interface/wx/mousestate.h
View File

@@ -108,7 +108,7 @@ public:
void SetX(wxCoord x);
void SetY(wxCoord y);
void SetPosition(const wxPoint& pos);
void SetLeftDown(bool down);
void SetMiddleDown(bool down);
void SetRightDown(bool down);
@@ -116,7 +116,7 @@ public:
void SetAux2Down(bool down);
void SetState(const wxMouseState& state);
};

10
interface/wx/msw/ole/automtn.h
View File

@@ -388,7 +388,7 @@ public:
@code
wxAutomationObject excelObject;
if ( excelObject.GetInstance("Excel.Application") )
excelObject.PutProperty("ActiveCell.Font.Bold", true);
@endcode
@@ -450,7 +450,7 @@ public:
Creates a new object based on the @a progID, returning @true if the object was
successfully created,
or @false if not.
@see GetInstance()
*/
bool CreateInstance(const wxString& progId) const;
@@ -495,7 +495,7 @@ public:
@param progId COM ProgID, e.g. "Excel.Application"
@param flags The creation flags (this parameters was added in wxWidgets
2.9.2)
@see CreateInstance()
*/
bool GetInstance(const wxString& progId,
@@ -532,11 +532,11 @@ public:
wxVariant res = obj.GetProperty("Range", wxVariant("A1"));
wxVariant res = obj.GetProperty("Range", "A1");
@endcode
Note that @a property can contain dot-separated property names, to save the
application
needing to call GetProperty several times using several temporary objects.
@see GetObject(), PutProperty()
*/
wxVariant GetProperty(const wxString& property, int noArgs,

2
interface/wx/msw/regconf.h
View File

@@ -25,7 +25,7 @@ public:
/**
The wxRegConfig constructor. For more info see the docs for the
wxConfigBase::wxConfigBase() constructor.
Note that wxRegConfig's @a style argument defaults to @c wxCONFIG_USE_GLOBAL_FILE,
i.e. to the use of the @c HKLM key (also known as "HKEY_LOCAL_MACHINE").
*/

48
interface/wx/notifmsg.h
View File

@@ -29,15 +29,15 @@
Windows 10 and for toast notification support on Windows 8 it is
recommended to call MSWUseToasts() before showing the first notification
message.
@par OS X
The OS X implementation uses Notification Center to display native notifications.
In order to use actions your notifications must use the alert style. This can
be enabled by the user in system settings or by setting the
@c NSUserNotificationAlertStyle value in Info.plist to @c alert. Please note
that the user always has the option to change the notification style.
@beginEventEmissionTable{wxCommandEvent}
@event{wxEVT_NOTIFICATION_MESSAGE_CLICK(id, func)}
Process a @c wxEVT_NOTIFICATION_MESSAGE_CLICK event, when a notification
@@ -49,7 +49,7 @@
Process a @c wxEVT_NOTIFICATION_MESSAGE_ACTION event, when the user
selects on of the actions added by AddAction()
@endEventTable
@since 2.9.0
@library{wxcore}
@category{misc}
@@ -93,11 +93,11 @@ public:
@return @false if the current implementation or OS version
does not support actions in notifications.
@since 3.1.0
*/
bool AddAction(wxWindowID actionid, const wxString &label = wxString());
/**
Hides the notification.
@@ -114,22 +114,22 @@ public:
Valid values are @c wxICON_INFORMATION, @c wxICON_WARNING and
@c wxICON_ERROR (notice that @c wxICON_QUESTION is not allowed here).
Some implementations of this class may not support the icons.
@see SetIcon()
*/
void SetFlags(int flags);
/**
Specify a custom icon to be displayed in the notification.
Some implementations of this class may not support custom icons.
@see SetFlags()
@since 3.1.0
*/
void SetIcon(const wxIcon& icon);
/**
Set the main text of the notification.
@@ -173,42 +173,42 @@ public:
If the application already uses a wxTaskBarIcon, it should be connected
to notifications by using this method. This has no effect if toast
notifications are used.
@return the task bar icon which was used previously (may be @c NULL)
@onlyfor{wxmsw}
*/
static wxTaskBarIcon *UseTaskBarIcon(wxTaskBarIcon *icon);
/**
Enables toast notifications available since Windows 8 and suppresses
the additional icon in the notification area on Windows 10.
Toast notifications @b require a shortcut to the application in the
start menu. The start menu shortcut needs to contain an Application
start menu. The start menu shortcut needs to contain an Application
User Model ID. It is recommended that the applications setup creates the
shortcut and the application specifies the setup created shortcut in
@c shortcutPath. A call to this method will verify (and if necessary
modify) the shortcut before enabling toast notifications.
@param shortcutPath
Path to a shortcut file referencing the applications executable. If
the string is empty the applications display name will be used. If
not fully qualified, it will be used as a path relative to the
Path to a shortcut file referencing the applications executable. If
the string is empty the applications display name will be used. If
not fully qualified, it will be used as a path relative to the
users start menu directory. The file extension .lnk is optional.
@param appId
The applications <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(vs.85).aspx">
Application User Model ID</a>. If empty it will be extracted from
the shortcut. If the shortcut does not contain an id an id will be
automatically created from the applications vendor and app name.
@return @false if toast notifications could not be enabled.
@onlyfor{wxmsw}
@see wxAppConsole::SetAppName(), wxAppConsole::SetVendorName()
@since 3.1.0
*/
static bool MSWUseToasts(

4
interface/wx/object.h
View File

@@ -718,7 +718,7 @@ public:
/**
Used in a C++ implementation file to complete the declaration of a class
that has run-time type information.
@header{wx/object.h}
Example:
@@ -736,7 +736,7 @@ public:
/**
Used in a C++ implementation file to complete the declaration of a class
that has run-time type information and two base classes.
that has run-time type information and two base classes.
@header{wx/object.h}
*/

6
interface/wx/overlay.h
View File

@@ -11,7 +11,7 @@
Creates an overlay over an existing window, allowing for manipulations like
rubberbanding, etc. On wxOSX the overlay is implemented with native
platform APIs, on the other platforms it is simulated using wxMemoryDC.
@library{wxcore}
@see wxDCOverlay, wxDC
@@ -35,11 +35,11 @@ public:
@class wxDCOverlay
Connects an overlay with a drawing DC.
@library{wxcore}
@see wxOverlay, wxDC
*/
class wxDCOverlay
{

2
interface/wx/pickerbase.h
View File

@@ -163,7 +163,7 @@ public:
virtual void UpdatePickerFromTextCtrl() = 0;
virtual void UpdateTextCtrlFromPicker() = 0;
protected:
virtual long GetTextCtrlStyle(long style) const;
virtual long GetPickerStyle(long style) const;

78
interface/wx/platinfo.h
View File

@@ -24,12 +24,12 @@ enum wxOperatingSystemId
wxOS_MAC_OS = 1 << 0, //!< Apple Mac OS 8/9/X with Mac paths
wxOS_MAC_OSX_DARWIN = 1 << 1, //!< Apple OS X with Unix paths
//! A combination of all @c wxOS_MAC_* values previously listed.
wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN,
wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (XP/Vista/7/8/10)
//! Any Windows system, currently can be only wxOS_WINDOWS_NT.
wxOS_WINDOWS = wxOS_WINDOWS_NT,
@@ -40,7 +40,7 @@ enum wxOperatingSystemId
wxOS_UNIX_SOLARIS = 1 << 10, //!< SunOS
wxOS_UNIX_AIX = 1 << 11, //!< AIX
wxOS_UNIX_HPUX = 1 << 12, //!< HP/UX
//! A combination of all @c wxOS_UNIX_* values previously listed.
wxOS_UNIX = wxOS_UNIX_LINUX |
wxOS_UNIX_FREEBSD |
@@ -104,9 +104,9 @@ enum wxEndianness
};
/**
A structure containing information about a Linux distribution as returned
A structure containing information about a Linux distribution as returned
by the @c lsb_release utility.
See wxGetLinuxDistributionInfo() or wxPlatformInfo::GetLinuxDistributionInfo()
for more info.
*/
@@ -116,7 +116,7 @@ struct wxLinuxDistributionInfo
wxString Release; //!< The version of the distribution; e.g. "9.04"
wxString CodeName; //!< The code name of the distribution; e.g. "jaunty"
wxString Description; //!< The description of the distribution; e.g. "Ubuntu 9.04"
bool operator==(const wxLinuxDistributionInfo& ldi) const;
bool operator!=(const wxLinuxDistributionInfo& ldi) const;
};
@@ -125,16 +125,16 @@ struct wxLinuxDistributionInfo
/**
@class wxPlatformInfo
This class holds information about the operating system, the toolkit and the
This class holds information about the operating system, the toolkit and the
basic architecture of the machine where the application is currently running.
This class does not only have @e getters for the information above, it also has
@e setters. This allows you to e.g. save the current platform information in a
@e setters. This allows you to e.g. save the current platform information in a
data file (maybe in string form) so that when you later load it, you can easily
retrieve (see the static getters for string->enum conversion functions) and store
inside a wxPlatformInfo instance (using its setters) the signature of the system
inside a wxPlatformInfo instance (using its setters) the signature of the system
which generated it.
In general however you only need to use the static Get() function and then
access the various information for the current platform:
@code
@@ -148,7 +148,7 @@ struct wxLinuxDistributionInfo
@see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(),
wxAppTraits, @ref group_funcmacro_networkuseros
*/
class wxPlatformInfo
class wxPlatformInfo
{
public:
@@ -211,16 +211,16 @@ public:
Equality operator. Tests all class' internal variables.
*/
bool operator==(const wxPlatformInfo& t) const;
/**
Returns the global wxPlatformInfo object, initialized with the values
for the currently running platform.
*/
static const wxPlatformInfo& Get();
/**
@name Static enum getters
These getters allow for easy string-to-enumeration-value conversion.
*/
//@{
@@ -251,13 +251,13 @@ public:
("wxGTK", "wxMSW", etc) nor any of the short wxWidgets name ports ("gtk", "msw", etc).
*/
static wxPortId GetPortId(const wxString& portname);
//@}
/**
@name Static string-form getters
These getters allow for easy enumeration-value-to-string conversion.
*/
//@{
@@ -271,7 +271,7 @@ public:
Returns name for the given wxEndianness enumeration value.
*/
static wxString GetEndiannessName(wxEndianness end);
/**
Returns the operating system family name for the given wxOperatingSystemId
enumeration value: @c Unix for @c wxOS_UNIX, @c OSX for @c wxOS_MAC_OS,
@@ -308,14 +308,14 @@ public:
/**
Returns the operating system directory.
See wxGetOSDirectory() for more info.
*/
static wxString GetOperatingSystemDirectory();
//@}
/**
@name Getters
*/
@@ -359,14 +359,14 @@ public:
/**
Returns the operating system ID of this wxPlatformInfo instance.
See wxGetOsVersion() for more info.
*/
wxOperatingSystemId GetOperatingSystemId() const;
/**
Returns the description of the operating system of this wxPlatformInfo instance.
See wxGetOsDescription() for more info.
*/
wxString GetOperatingSystemDescription() const;
@@ -375,17 +375,17 @@ public:
Returns the wxWidgets port ID associated with this wxPlatformInfo instance.
*/
wxPortId GetPortId() const;
/**
Returns the Linux distribution info associated with this wxPlatformInfo instance.
See wxGetLinuxDistributionInfo() for more info.
*/
wxLinuxDistributionInfo GetLinuxDistributionInfo() const;
/**
Returns the desktop environment associated with this wxPlatformInfo instance.
See wxAppTraits::GetDesktopEnvironment() for more info.
*/
wxString GetDesktopEnvironment() const;
@@ -454,7 +454,7 @@ public:
wxPlatformInfo instance.
*/
wxString GetOperatingSystemFamilyName() const;
/**
Returns the operating system name of the OS associated with this wxPlatformInfo
instance.
@@ -472,16 +472,16 @@ public:
wxPlatformInfo instance.
*/
wxString GetPortIdShortName() const;
//@}
//@}
/**
@name Setters
*/
//@{
/**
Sets the architecture enum value associated with this wxPlatformInfo instance.
*/
@@ -517,17 +517,17 @@ public:
Sets the operating system description associated with this wxPlatformInfo instance.
*/
void SetOperatingSystemDescription(const wxString& desc);
/**
Sets the desktop environment associated with this wxPlatformInfo instance.
*/
void SetDesktopEnvironment(const wxString& de);
/**
Sets the linux distribution info associated with this wxPlatformInfo instance.
*/
void SetLinuxDistributionInfo(const wxLinuxDistributionInfo& di);
//@}
};

4
interface/wx/popupwin.h
View File

@@ -38,7 +38,7 @@ public:
Default constructor
*/
wxPopupWindow();
/**
Constructor
*/
@@ -125,5 +125,5 @@ protected:
else but direct call to Dismiss().
*/
virtual void OnDismiss();
};

2
interface/wx/power.h
View File

@@ -80,7 +80,7 @@ class wxPowerEvent : public wxEvent
public:
wxPowerEvent();
wxPowerEvent(wxEventType evtType);
/**
Call this to prevent suspend from taking place in @c wxEVT_POWER_SUSPENDING
handler (it is ignored for all the others).

24
interface/wx/process.h
View File

@@ -15,7 +15,7 @@
notified about the process termination and also retrieve its exit status which is
unavailable from ::wxExecute() in the case of asynchronous execution.
@note
@note
If the @c wxEVT_END_PROCESS event sent after termination is processed by the
parent, then it is responsible for deleting the wxProcess object which sent it.
However, if it is not processed, the object will <b>delete itself</b> and so the
@@ -110,17 +110,17 @@ public:
/**
Detaches this event handler from the parent specified in the constructor
(see wxEvtHandler::Unlink() for a similar but not identical function).
Normally, a wxProcess object is deleted by its parent when it receives the
notification about the process termination.
However, it might happen that the parent object is destroyed before the external
process is terminated (e.g. a window from which this external process was launched
is closed by the user) and in this case it @b should not delete the wxProcess
object, but @b should call Detach() instead.
After the wxProcess object is detached from its parent, no notification events
will be sent to the parent and the object will delete itself upon reception of
notification about the process termination.
However, it might happen that the parent object is destroyed before the external
process is terminated (e.g. a window from which this external process was launched
is closed by the user) and in this case it @b should not delete the wxProcess
object, but @b should call Detach() instead.
After the wxProcess object is detached from its parent, no notification events
will be sent to the parent and the object will delete itself upon reception of
the process termination notification.
*/
void Detach();
@@ -211,7 +211,7 @@ public:
/**
It is called when the process with the pid @a pid finishes.
It raises a wxWidgets event when it isn't overridden.
Note that this function won't be called if you Kill() the process.
@param pid

2
interface/wx/progdlg.h
View File

@@ -167,7 +167,7 @@ public:
/**
Changes the maximum value of the progress meter given in the constructor.
This function can only be called (with a positive value) if the value passed
This function can only be called (with a positive value) if the value passed
in the constructor was positive.
@since 2.9.1

8
interface/wx/propdlg.h
View File

@@ -197,7 +197,7 @@ public:
*/
void SetSheetStyle(long style);
/**
Set the border around the whole dialog
*/
@@ -208,18 +208,18 @@ public:
*/
int GetSheetOuterBorder() const;
/**
Set the border around the book control only.
*/
void SetSheetInnerBorder(int border);
/**
Returns the border around the book control only.
*/
int GetSheetInnerBorder() const;
virtual wxWindow* GetContentWindow() const;
};

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

@@ -427,7 +427,7 @@ public:
class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor
{
wxDECLARE_DYNAMIC_CLASS(wxSampleMultiButtonEditor);
public:
wxSampleMultiButtonEditor() {}
virtual ~wxSampleMultiButtonEditor() {}

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

@@ -516,7 +516,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000
Note that when displaying the value, sign is omitted if the resulting
textual representation is effectively zero (for example, -0.0001 with
precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike
precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike
what C standard library does, but should result in better end-user
experience in almost all cases.

4
interface/wx/propgrid/propgridpagestate.h
View File

@@ -227,7 +227,7 @@ class wxPropertyGridIterator : public wxPropertyGridIteratorBase
public:
wxPropertyGridIterator();
wxPropertyGridIterator( wxPropertyGridPageState* state,
int flags = wxPG_ITERATE_DEFAULT,
int flags = wxPG_ITERATE_DEFAULT,
wxPGProperty* property = NULL, int dir = 1 );
wxPropertyGridIterator( wxPropertyGridPageState* state,
int flags, int startPos, int dir = 0 );
@@ -252,7 +252,7 @@ public:
wxPropertyGridConstIterator();
wxPropertyGridConstIterator( const wxPropertyGridPageState* state,
int flags = wxPG_ITERATE_DEFAULT,
int flags = wxPG_ITERATE_DEFAULT,
const wxPGProperty* property = NULL, int dir = 1 );
wxPropertyGridConstIterator( wxPropertyGridPageState* state,
int flags, int startPos, int dir = 0 );

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

@@ -312,7 +312,7 @@ public:
const wxChar* const* labels = NULL,
const long* values = NULL,
int value = 0 );
wxEnumProperty( const wxString& label,
const wxString& name,
wxPGChoices& choices,

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

@@ -132,7 +132,7 @@ public:
/**
Detach the existing logger without deleting it.
The caller is responsible for deleting the returned pointer if it's
non-@c NULL.
*/

2
interface/wx/rearrangectrl.h
View File

@@ -301,7 +301,7 @@ public:
/**
Effectively creates the dialog for an object created using the default
constructor.
constructor.
@param parent
The dialog parent, possibly @NULL.

2
interface/wx/renderer.h
View File

@@ -635,7 +635,7 @@ public:
struct wxRendererVersion
{
wxRendererVersion(int version_, int age_);
/**
Checks if the main program is compatible with the renderer having the version
@e ver, returns @true if it is and @false otherwise.

126
interface/wx/ribbon/art.h
View File

@@ -8,7 +8,7 @@
/**
Identifiers for common settings on ribbon art providers which can be used
to tweak the appearance of the art provider.
@see wxRibbonArtProvider::GetColour()
@see wxRibbonArtProvider::GetFont()
@see wxRibbonArtProvider::GetMetric()
@@ -127,7 +127,7 @@ enum wxRibbonArtSetting
/**
Flags used to describe the direction, state, and/or purpose of a
ribbon-style scroll button.
@see wxRibbonArtProvider::DrawScrollButton()
@see wxRibbonArtProvider::GetScrollButtonMinimumSize()
*/
@@ -167,19 +167,19 @@ enum wxRibbonButtonKind
action.
*/
wxRIBBON_BUTTON_NORMAL = 1 << 0,
/**
Dropdown button or tool with a clickable area which typically causes a
dropdown menu.
*/
wxRIBBON_BUTTON_DROPDOWN = 1 << 1,
/**
Button or tool with two clickable areas - one which causes a dropdown
menu, and one which causes a generic action.
*/
wxRIBBON_BUTTON_HYBRID = wxRIBBON_BUTTON_NORMAL | wxRIBBON_BUTTON_DROPDOWN,
/**
Normal button or tool with a clickable area which toggles the button
between a pressed and unpressed state.
@@ -216,7 +216,7 @@ public:
Constructor.
*/
wxRibbonArtProvider();
/**
Destructor.
*/
@@ -226,16 +226,16 @@ public:
Create a new art provider which is a clone of this one.
*/
virtual wxRibbonArtProvider* Clone() const = 0;
/**
Set the style flags.
Normally called automatically by wxRibbonBar::SetArtProvider with the ribbon
bar's style flags, so that the art provider has the same flags as the bar which
it is serving.
*/
virtual void SetFlags(long flags) = 0;
/**
Get the previously set style flags.
*/
@@ -246,53 +246,53 @@ public:
@a id can be one of the size values of @ref wxRibbonArtSetting.
*/
virtual int GetMetric(int id) const = 0;
/**
Set the value of a certain integer setting to the value @e new_val.
@a id can be one of the size values of @ref wxRibbonArtSetting.
*/
virtual void SetMetric(int id, int new_val) = 0;
/**
Set the value of a certain font setting to the value @e font.
@a id can be one of the font values of @ref wxRibbonArtSetting.
*/
virtual void SetFont(int id, const wxFont& font) = 0;
/**
Get the value of a certain font setting.
@a id can be one of the font values of @ref wxRibbonArtSetting.
*/
virtual wxFont GetFont(int id) const = 0;
/**
Get the value of a certain colour setting.
@a id can be one of the colour values of @ref wxRibbonArtSetting.
*/
virtual wxColour GetColour(int id) const = 0;
/**
Set the value of a certain colour setting to the value @e colour.
@a id can be one of the colour values of @ref wxRibbonArtSetting, though
not all colour settings will have an effect on every art provider.
@see SetColourScheme()
*/
virtual void SetColour(int id, const wxColour& colour) = 0;
/**
@see wxRibbonArtProvider::GetColour()
*/
wxColour GetColor(int id) const;
/**
@see wxRibbonArtProvider::SetColour()
*/
void SetColor(int id, const wxColour& color);
/**
Get the current colour scheme.
Returns three colours such that if SetColourScheme() were called with
them, the colour scheme would be restored to what it was when
SetColourScheme() was last called. In practice, this usually means that
@@ -308,7 +308,7 @@ public:
and return a colour scheme similar to colours being used - it's return
values are dependent upon the last values given to SetColourScheme(),
as described above.
@param[out] primary
Pointer to a location to store the primary colour, or NULL.
@param[out] secondary
@@ -319,26 +319,26 @@ public:
virtual void GetColourScheme(wxColour* primary,
wxColour* secondary,
wxColour* tertiary) const = 0;
/**
Set all applicable colour settings from a few base colours.
Uses any or all of the three given colours to create a colour scheme,
and then sets all colour settings which are relevant to the art
provider using that scheme.
Note that some art providers may not use the tertiary colour for
anything, and some may not use the secondary colour either.
@see SetColour()
@see GetColourScheme()
*/
*/
virtual void SetColourScheme(const wxColour& primary,
const wxColour& secondary,
const wxColour& tertiary) = 0;
/**
Draw the background of the tab region of a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -353,7 +353,7 @@ public:
/**
Draw a single tab in the tab region of a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -373,7 +373,7 @@ public:
/**
Draw a separator between two tabs in a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -393,7 +393,7 @@ public:
/**
Draw the background of a ribbon page.
@param dc
The device context to draw onto.
@param wnd
@@ -401,7 +401,7 @@ public:
whose background is being drawn, but doesn't have to be).
@param rect
The rectangle within which to draw.
@sa GetPageBackgroundRedrawArea
*/
virtual void DrawPageBackground(
@@ -411,7 +411,7 @@ public:
/**
Draw a ribbon-style scroll button.
@param dc
The device context to draw onto.
@param wnd
@@ -439,11 +439,11 @@ public:
Draw the background and chrome for a ribbon panel. This should draw
the border, background, label, and any other items of a panel which
are outside the client area of a panel.
Note that when a panel is minimised, this function is not called - only
DrawMinimisedPanel() is called, so a background should be explicitly
painted by that if required.
@param dc
The device context to draw onto.
@param wnd
@@ -457,13 +457,13 @@ public:
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect) = 0;
/**
Draw the background and chrome for a wxRibbonGallery control. This
should draw the border, background, scroll buttons, extension button,
and any other UI elements which are not attached to a specific gallery
item.
@param dc
The device context to draw onto.
@param wnd
@@ -488,7 +488,7 @@ public:
is painted on top of a gallery background, and behind the items bitmap.
Unlike DrawButtonBarButton() and DrawTool(), it is not expected to draw
the item bitmap - that is done by the gallery control itself.
@param dc
The device context to draw onto.
@param wnd
@@ -515,10 +515,10 @@ public:
wxRibbonGallery* wnd,
const wxRect& rect,
wxRibbonGalleryItem* item) = 0;
/**
Draw a minimised ribbon panel.
@param dc
The device context to draw onto.
@param wnd
@@ -539,10 +539,10 @@ public:
wxRibbonPanel* wnd,
const wxRect& rect,
wxBitmap& bitmap) = 0;
/**
Draw the background for a wxRibbonButtonBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -558,7 +558,7 @@ public:
/**
Draw a single button for a wxRibbonButtonBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -591,10 +591,10 @@ public:
const wxString& label,
const wxBitmap& bitmap_large,
const wxBitmap& bitmap_small) = 0;
/**
Draw the background for a wxRibbonToolBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -613,7 +613,7 @@ public:
/**
Draw the background for a group of tools on a wxRibbonToolBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -636,7 +636,7 @@ public:
/**
Draw a single tool (for a wxRibbonToolBar control).
@param dc
The device context to draw onto.
@param wnd
@@ -710,7 +710,7 @@ public:
/**
Calculate the ideal and minimum width (in pixels) of a tab in a ribbon
bar.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -746,7 +746,7 @@ public:
Note that as the tab region can contain scroll buttons, the height
should be greater than or equal to the minimum height for a tab scroll
button.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -761,7 +761,7 @@ public:
/**
Calculate the minimum size (in pixels) of a scroll button.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -781,7 +781,7 @@ public:
Calculate the size of a panel for a given client size. This should
increment the given size by enough to fit the panel label and other
chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -791,7 +791,7 @@ public:
@param[out] client_offset
The offset where the client rectangle begins within the panel (may
be NULL).
@sa GetPanelClientSize()
*/
virtual wxSize GetPanelSize(
@@ -799,12 +799,12 @@ public:
const wxRibbonPanel* wnd,
wxSize client_size,
wxPoint* client_offset) = 0;
/**
Calculate the client size of a panel for a given overall size. This
should act as the inverse to GetPanelSize(), and decrement the given
size by enough to fit the panel label and other chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -814,7 +814,7 @@ public:
@param[out] client_offset
The offset where the returned client size begins within the given
@a size (may be NULL).
@sa GetPanelSize()
*/
virtual wxSize GetPanelClientSize(
@@ -844,14 +844,14 @@ public:
Calculate the size of a wxRibbonGallery control for a given client
size. This should increment the given size by enough to fit the gallery
border, buttons, and any other chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
The gallery in question.
@param client_size
The client size.
@sa GetGalleryClientSize()
*/
virtual wxSize GetGallerySize(
@@ -864,7 +864,7 @@ public:
size. This should act as the inverse to GetGallerySize(), and decrement
the given size by enough to fit the gallery border, buttons, and other
chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -899,7 +899,7 @@ public:
small an area as possible should be returned. Of course, if the way in
which a background is drawn means that the entire background needs to
be repainted on resize, then the entire new size should be returned.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -915,10 +915,10 @@ public:
const wxRibbonPage* wnd,
wxSize page_old_size,
wxSize page_new_size) = 0;
/**
Calculate the size of a button within a wxRibbonButtonBar.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -947,7 +947,7 @@ public:
The region of the button which constitutes the normal button.
@param[out] dropdown_region
The region of the button which constitutes the dropdown button.
@return @true if a size exists for the button, @false otherwise.
*/
virtual bool GetButtonBarButtonSize(
@@ -990,10 +990,10 @@ public:
wxDC& dc, const wxString& label,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size) = 0;
/**
Calculate the size of a minimised ribbon panel.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -1011,10 +1011,10 @@ public:
const wxRibbonPanel* wnd,
wxSize* desired_bitmap_size,
wxDirection* expanded_panel_direction) = 0;
/**
Calculate the size of a tool within a wxRibbonToolBar.
@param dc
A device context to use when one is required for size calculations.
@param wnd

38
interface/wx/ribbon/bar.h
View File

@@ -77,7 +77,7 @@ public:
Returns the page being changed to, or being clicked on.
*/
wxRibbonPage* GetPage();
/**
Sets the page relating to this event.
*/
@@ -120,7 +120,7 @@ public:
for wxRibbonPage - a ribbon user interface typically has a ribbon bar,
which contains one or more wxRibbonPages, which in turn each contain one
or more wxRibbonPanels, which in turn contain controls.
While a wxRibbonBar has tabs similar to a wxNotebook, it does not follow
the same API for adding pages. Containers like wxNotebook can contain any
type of window as a page, hence the normal procedure is to create the
@@ -128,13 +128,13 @@ public:
have wxRibbonPage as children (and a wxRibbonPage can only have a
wxRibbonBar as parent), when a page is created, it is automatically added
to the bar - there is no AddPage equivalent to call.
After all pages have been created, and all controls and panels placed on
those pages, Realize() must be called.
@sa wxRibbonPage
@sa wxRibbonPanel
@beginStyleTable
@style{wxRIBBON_BAR_DEFAULT_STYLE}
Defined as wxRIBBON_BAR_FLOW_HORIZONTAL |
@@ -213,7 +213,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxRIBBON_BAR_DEFAULT_STYLE);
/**
Create a ribbon bar in two-step ribbon bar construction.
Should only be called when the default constructor is used, and
@@ -235,7 +235,7 @@ public:
tab bar region of the ribbon bar. These margins will be painted with
the tab background, but tabs and scroll buttons will never be painted
in the margins.
The left margin could be used for rendering something equivalent to the
"Office Button", though this is not currently implemented. The right
margin could be used for rendering a help button, and/or MDI buttons,
@@ -247,7 +247,7 @@ public:
Set the art provider to be used be the ribbon bar. Also sets the art
provider on all current wxRibbonPage children, and any wxRibbonPage
children added in the future.
Note that unlike most other ribbon controls, the ribbon bar creates a
default art provider when initialised, so an explicit call to
SetArtProvider() is not required if the default art provider is
@@ -260,17 +260,17 @@ public:
/**
Set the active page by index, without triggering any events.
@param page
The zero-based index of the page to activate.
@return @true if the specified page is now active, @false if it could
not be activated (for example because the page index is invalid).
*/
bool SetActivePage(size_t page);
/**
Set the active page, without triggering any events.
@param page
The page to activate.
@return @true if the specified page is now active, @false if it could
@@ -278,21 +278,21 @@ public:
of the ribbon bar).
*/
bool SetActivePage(wxRibbonPage* page);
/**
Get the index of the active page.
In the rare case of no page being active, -1 is returned.
*/
int GetActivePage() const;
/**
Get a page by index.
NULL will be returned if the given index is out of range.
*/
wxRibbonPage* GetPage(int n);
/**
Get the number of pages in this bar.
@@ -302,7 +302,7 @@ public:
/**
Dismiss the expanded panel of the currently active page.
Calls and returns the value from wxRibbonPage::DismissExpandedPanel()
for the currently active page, or @false if there is no active page.
*/
@@ -433,7 +433,7 @@ public:
@since 2.9.2
*/
bool ArePanelsShown() const;
/**
Returns the current display mode of the panel area.
@@ -449,7 +449,7 @@ public:
children. This must be called after all of the bar's children have been
created (and their children created, etc.) - if it is not, then windows
may not be laid out or sized correctly.
Also calls wxRibbonPage::Realize() on each child page.
*/
virtual bool Realize();

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