automated ifacecheck fixed

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56553 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-28 15:36:26 +00:00
parent 56454c1513
commit 43c48e1e53
55 changed files with 190 additions and 213 deletions

View File

@@ -234,7 +234,7 @@ public:
/** /**
Returns the last position in the combobox text field. Returns the last position in the combobox text field.
*/ */
virtual wxTextPos GetLastPosition() const; virtual long GetLastPosition() const;
/** /**
This is the same as wxTextCtrl::GetSelection() for the text control This is the same as wxTextCtrl::GetSelection() for the text control

View File

@@ -133,7 +133,7 @@ public:
@remarks If the format parameter is invalid, the behaviour is undefined. @remarks If the format parameter is invalid, the behaviour is undefined.
*/ */
void SetFormat(const wxChar* format); bool SetFormat(const wxString& format);
/** /**
Sets the valid range for the date selection. If @a dt1 is valid, it Sets the valid range for the date selection. If @a dt1 is valid, it

View File

@@ -461,7 +461,7 @@ public:
@see SetUserScale() @see SetUserScale()
*/ */
void GetUserScale(double x, double y); void GetUserScale(double* x, double* y) const;
/** /**
Converts logical X coordinate to device coordinate, using the current Converts logical X coordinate to device coordinate, using the current

View File

@@ -377,7 +377,7 @@ public:
Iconize(@false) will bring the window to the front, as does Iconize(@false) will bring the window to the front, as does
Show(@true). Show(@true).
*/ */
void Iconize(bool iconize); virtual void Iconize(bool iconize = true);
/** /**
Returns @true if the dialog box is iconized. Windows only. Returns @true if the dialog box is iconized. Windows only.

View File

@@ -77,12 +77,11 @@ public:
Creates the editable listbox for two-step construction. Creates the editable listbox for two-step construction.
See wxEditableListBox() for further details. See wxEditableListBox() for further details.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxString& label,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxEL_DEFAULT_STYLE, long style = wxEL_DEFAULT_STYLE,
const wxString& name = "editableListBox"); const wxString& name = wxEditableListBoxNameStr);
/** /**
Replaces current contents with given strings. Replaces current contents with given strings.

View File

@@ -2399,7 +2399,7 @@ public:
@see SetOrigin() @see SetOrigin()
*/ */
wxHelpEventOrigin GetOrigin() const; wxHelpEvent::Origin GetOrigin() const;
/** /**
Returns the left-click position of the mouse, in screen coordinates. Returns the left-click position of the mouse, in screen coordinates.
@@ -2412,7 +2412,7 @@ public:
@see GetOrigin() @see GetOrigin()
*/ */
void SetOrigin(wxHelpEventOrigin); void SetOrigin(wxHelpEvent::Origin origin);
/** /**
Sets the left-click position of the mouse, in screen coordinates. Sets the left-click position of the mouse, in screen coordinates.

View File

@@ -124,7 +124,7 @@ public:
/** /**
Get the string to find. Get the string to find.
*/ */
const wxString GetFindString(); const wxString& GetFindString();
/** /**
Get the combination of @c wxFindReplaceFlags values. Get the combination of @c wxFindReplaceFlags values.
@@ -134,7 +134,7 @@ public:
/** /**
Get the replacement string. Get the replacement string.
*/ */
const wxString GetReplaceString(); const wxString& GetReplaceString();
/** /**
Set the string to find (used as initial value by the dialog). Set the string to find (used as initial value by the dialog).

View File

@@ -90,7 +90,7 @@ public:
The descriptor should be already opened and it will be closed by wxFFile object. The descriptor should be already opened and it will be closed by wxFFile object.
*/ */
void Attach(FILE* fp); void Attach(FILE* fp, const wxString& name = wxEmptyString);
/** /**
Closes the file and returns @true on success. Closes the file and returns @true on success.

View File

@@ -96,11 +96,10 @@ public:
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id,
const wxString& defaultDirectory = wxEmptyString, const wxString& defaultDirectory = wxEmptyString,
const wxString& defaultFilename = wxEmptyString, const wxString& defaultFilename = wxEmptyString,
const wxPoint& wildCard = wxFileSelectorDefaultWildcardStr, const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
long style = wxFC_DEFAULT_STYLE, long style = wxFC_DEFAULT_STYLE, const wxPoint& pos = wxDefaultPosition,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
const wxString& name = "filectrl"); const wxString& name = wxFileCtrlNameStr);
/** /**
Returns the current directory of the file control (i.e. the directory shown by it). Returns the current directory of the file control (i.e. the directory shown by it).
@@ -178,7 +177,7 @@ public:
/** /**
Sets whether hidden files and folders are shown or not. Sets whether hidden files and folders are shown or not.
*/ */
void ShowHidden(const bool show); virtual void ShowHidden(bool show);
}; };
@@ -233,7 +232,7 @@ public:
/** /**
Sets the files changed by this event. Sets the files changed by this event.
*/ */
void SetFiles(const wxArrayString files); void SetFiles(const wxArrayString& files);
/** /**

View File

@@ -102,13 +102,13 @@ public:
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString, const wxString& path = wxEmptyString,
const wxString& message = "Select a file", const wxString& message = wxFileSelectorPromptStr,
const wxString& wildcard = ".", const wxString& wildcard = wxFileSelectorDefaultWildcardStr,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxFLP_DEFAULT_STYLE, long style = wxFLP_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "filepickerctrl"); const wxString& name = wxFilePickerCtrlNameStr);
/** /**
Similar to GetPath() but returns the path of the currently selected Similar to GetPath() but returns the path of the currently selected
@@ -222,12 +222,12 @@ public:
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id,
const wxString& path = wxEmptyString, const wxString& path = wxEmptyString,
const wxString& message = "Select a folder", const wxString& message = wxDirSelectorPromptStr,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxDIRP_DEFAULT_STYLE, long style = wxDIRP_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "dirpickerctrl"); const wxString& name = wxDirPickerCtrlNameStr);
/** /**
Returns the absolute path of the currently selected directory as a Returns the absolute path of the currently selected directory as a

View File

@@ -107,7 +107,7 @@ public:
@param file @param file
the name of the file to look for the name of the file to look for
*/ */
bool FindFileInPath(wxString str, const wxString& path, bool FindFileInPath(wxString* pStr, const wxString& path,
const wxString& file); const wxString& file);
/** /**
@@ -238,7 +238,7 @@ public:
You will have to delete the stream yourself. You will have to delete the stream yourself.
*/ */
void DetachStream(); wxInputStream* DetachStream();
/** /**
Returns anchor (if present). The term of @b anchor can be easily Returns anchor (if present). The term of @b anchor can be easily

View File

@@ -39,7 +39,7 @@ public:
Call OnFontEncoding() for each encoding supported by the given font - Call OnFontEncoding() for each encoding supported by the given font -
or for each encoding supported by at least some font if @a font is not specified. or for each encoding supported by at least some font if @a font is not specified.
*/ */
virtual bool EnumerateEncodings(const wxString& font = ""); virtual bool EnumerateEncodings(const wxString& font = wxEmptyString);
/** /**
Call OnFacename() for each font which supports given encoding (only if Call OnFacename() for each font which supports given encoding (only if

View File

@@ -175,12 +175,11 @@ public:
Used in two-step frame construction. Used in two-step frame construction.
See wxFrame() for further details. See wxFrame() for further details.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
const wxString& title,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_FRAME_STYLE, long style = wxDEFAULT_FRAME_STYLE,
const wxString& name = "frame"); const wxString& name = wxFrameNameStr);
/** /**
Creates a status bar at the bottom of the frame. Creates a status bar at the bottom of the frame.
@@ -205,10 +204,9 @@ public:
@see SetStatusText(), OnCreateStatusBar(), GetStatusBar() @see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
*/ */
virtual wxStatusBar* CreateStatusBar(int number = 1, virtual wxStatusBar* CreateStatusBar(int number = 1, long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
long style = 0, wxWindowID id = 0,
wxWindowID id = -1, const wxString& name = wxStatusLineNameStr);
const wxString& name = "statusBar");
/** /**
Creates a toolbar at the top or left of the frame. Creates a toolbar at the top or left of the frame.
@@ -241,8 +239,8 @@ public:
@see CreateStatusBar(), OnCreateToolBar(), SetToolBar(), GetToolBar() @see CreateStatusBar(), OnCreateToolBar(), SetToolBar(), GetToolBar()
*/ */
virtual wxToolBar* CreateToolBar(long style = wxBORDER_NONE | wxTB_HORIZONTAL, virtual wxToolBar* CreateToolBar(long style = wxBORDER_NONE | wxTB_HORIZONTAL,
wxWindowID id = -1, wxWindowID id = wxID_ANY,
const wxString& name = "toolBar"); const wxString& name = wxToolBarNameStr);
/** /**
Returns the origin of the frame client area (in client coordinates). Returns the origin of the frame client area (in client coordinates).
@@ -398,7 +396,7 @@ public:
width of all fields, minus the sum of widths of the width of all fields, minus the sum of widths of the
non-variable fields, divided by the number of variable fields. non-variable fields, divided by the number of variable fields.
*/ */
virtual void SetStatusWidths(int n, int* widths); virtual void SetStatusWidths(int n, const int* widths_field);
/** /**
Associates a toolbar with the frame. Associates a toolbar with the frame.

View File

@@ -87,10 +87,9 @@ public:
*/ */
bool Create(wxWindow* parent, wxWindowID id, int range, bool Create(wxWindow* parent, wxWindowID id, int range,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL,
long style = wxGA_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "gauge"); const wxString& name = wxGaugeNameStr);
/** /**
Returns the width of the 3D bezel face. Returns the width of the 3D bezel face.

View File

@@ -111,13 +111,11 @@ public:
@param name @param name
Window name. Window name.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxString& label, const wxString& url, const wxPoint& pos = wxDefaultPosition,
const wxString& url,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxHL_DEFAULT_STYLE, long style = wxHL_DEFAULT_STYLE,
const wxString& name = "hyperlink"); const wxString& name = wxHyperlinkCtrlNameStr);
/** /**
Returns the colour used to print the label of the hyperlink when the mouse is Returns the colour used to print the label of the hyperlink when the mouse is

View File

@@ -271,7 +271,7 @@ public:
@param icon @param icon
Icon to assign. Icon to assign.
*/ */
wxIcon operator =(const wxIcon& icon); wxIcon& operator=(const wxIcon& icon);
}; };
/** /**

View File

@@ -91,7 +91,7 @@ public:
/** /**
Assignment operator, using @ref overview_refcount "reference counting". Assignment operator, using @ref overview_refcount "reference counting".
*/ */
wxIconBundle operator =(const wxIconBundle& ic); wxIconBundle& operator=(const wxIconBundle& ic);
/** /**
Equality operator. This returns @true if two icon bundles are equal. Equality operator. This returns @true if two icon bundles are equal.

View File

@@ -666,7 +666,7 @@ public:
@see AddCatalog() @see AddCatalog()
*/ */
bool IsLoaded(const char* domain) const; bool IsLoaded(const wxString& domain) const;
/** /**
Returns @true if the locale could be set successfully. Returns @true if the locale could be set successfully.

View File

@@ -225,7 +225,7 @@ public:
@param name @param name
Window name. Window name.
*/ */
bool Create(wxSashLayoutWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxCLIP_CHILDREN | wxSW_3D, long style = wxCLIP_CHILDREN | wxSW_3D,
@@ -316,7 +316,7 @@ public:
client area the window sticks to). client area the window sticks to).
One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM. One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
*/ */
void GetAlignment() const; wxLayoutAlignment GetAlignment() const;
/** /**
Returns the flags associated with this event. Not currently used. Returns the flags associated with this event. Not currently used.

View File

@@ -57,19 +57,19 @@ public:
@see OnFrameDelete() @see OnFrameDelete()
*/ */
virtual bool OnFrameClose(wxFrame frame); virtual bool OnFrameClose(wxFrame* frame);
/** /**
Called immediately after the log frame creation allowing for Called immediately after the log frame creation allowing for
any extra initializations. any extra initializations.
*/ */
virtual void OnFrameCreate(wxFrame frame); virtual void OnFrameCreate(wxFrame* frame);
/** /**
Called right before the log frame is going to be deleted: will Called right before the log frame is going to be deleted: will
always be called unlike OnFrameClose(). always be called unlike OnFrameClose().
*/ */
virtual void OnFrameDelete(wxFrame frame); virtual void OnFrameDelete(wxFrame* frame);
/** /**
Shows or hides the frame. Shows or hides the frame.
@@ -456,7 +456,7 @@ public:
The buffer can be cleared by Flush() which will also show the current The buffer can be cleared by Flush() which will also show the current
contents to the user. contents to the user.
*/ */
const wxString GetBuffer(); const wxString& GetBuffer() const;
}; };

View File

@@ -315,7 +315,7 @@ public:
@row2col{wxMEDIASTATE_PLAYING, The movie is currently playing.} @row2col{wxMEDIASTATE_PLAYING, The movie is currently playing.}
@endTable @endTable
*/ */
wxMediaCtrlState GetState(); wxMediaState GetState();
/** /**
Gets the volume of the media from a 0.0 to 1.0 range. Gets the volume of the media from a 0.0 to 1.0 range.
@@ -352,13 +352,13 @@ public:
/** /**
Same as Load(const wxURI& uri). Kept for wxPython compatibility. Same as Load(const wxURI& uri). Kept for wxPython compatibility.
*/ */
bool LoadURI(const wxURI& uri); bool LoadURI(const wxString& fileName);
/** /**
Same as Load(const wxURI& uri, const wxURI& proxy). Same as Load(const wxURI& uri, const wxURI& proxy).
Kept for wxPython compatibility. Kept for wxPython compatibility.
*/ */
bool LoadURIWithProxy(const wxURI& uri, const wxURI& proxy); bool LoadURIWithProxy(const wxString& fileName, const wxString& proxy);
/** /**
Pauses playback of the movie. Pauses playback of the movie.
@@ -376,7 +376,7 @@ public:
@todo Document the wxSeekMode parameter @a mode, and perhaps also the @todo Document the wxSeekMode parameter @a mode, and perhaps also the
wxFileOffset and wxSeekMode themselves. wxFileOffset and wxSeekMode themselves.
*/ */
wxFileOffset Seek(wxFileOffset where, wxSeekMode mode); wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
/** /**
Sets the playback rate, or speed of the media, to that referred by @a dRate. Sets the playback rate, or speed of the media, to that referred by @a dRate.

View File

@@ -33,7 +33,7 @@ public:
success. Returns -1 if an error was detected that prevents success. Returns -1 if an error was detected that prevents
further checking. further checking.
*/ */
int Check(); static int Check(bool checkAll = false);
/** /**
Performs a memory dump from the currently set checkpoint, writing to the Performs a memory dump from the currently set checkpoint, writing to the

View File

@@ -89,7 +89,7 @@ public:
@remarks Only use this when the menu bar has been associated with a @remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call. frame; otherwise, use the wxMenu equivalent call.
*/ */
void Check(int id, const bool check); void Check(int id, bool check);
/** /**
Enables or disables (greys out) a menu item. Enables or disables (greys out) a menu item.
@@ -114,7 +114,7 @@ public:
@remarks Only use this when the menu bar has been associated with a frame. @remarks Only use this when the menu bar has been associated with a frame.
*/ */
void EnableTop(int pos, const bool enable); virtual void EnableTop(size_t pos, bool enable);
/** /**
Finds the menu item object associated with the given menu item identifier. Finds the menu item object associated with the given menu item identifier.
@@ -126,7 +126,7 @@ public:
@return The found menu item object, or @NULL if one was not found. @return The found menu item object, or @NULL if one was not found.
*/ */
wxMenuItem* FindItem(int id, wxMenu menu = NULL) const; virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const;
/** /**
Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no
@@ -197,12 +197,12 @@ public:
@see SetLabelTop() @see SetLabelTop()
*/ */
wxString GetLabelTop(int pos) const; wxString GetLabelTop(size_t pos) const;
/** /**
Returns the menu at @a menuIndex (zero-based). Returns the menu at @a menuIndex (zero-based).
*/ */
wxMenu* GetMenu(int menuIndex) const; wxMenu* GetMenu(size_t menuIndex) const;
/** /**
Returns the number of menus in this menubar. Returns the number of menus in this menubar.
@@ -223,7 +223,7 @@ public:
@see GetMenuLabelText(), SetMenuLabel() @see GetMenuLabelText(), SetMenuLabel()
*/ */
wxString GetMenuLabel(int pos) const; virtual wxString GetMenuLabel(size_t pos) const;
/** /**
Returns the label of a top-level menu. Note that the returned string does not Returns the label of a top-level menu. Note that the returned string does not
@@ -239,7 +239,7 @@ public:
@see GetMenuLabel(), SetMenuLabel() @see GetMenuLabel(), SetMenuLabel()
*/ */
wxString GetMenuLabelText(int pos) const; virtual wxString GetMenuLabelText(size_t pos) const;
/** /**
Inserts the menu at the given position into the menu bar. Inserting menu at Inserts the menu at the given position into the menu bar. Inserting menu at
@@ -282,7 +282,7 @@ public:
/** /**
Redraw the menu bar Redraw the menu bar
*/ */
void Refresh(); virtual void Refresh(bool eraseBackground = true, const wxRect* rect = NULL);
/** /**
Removes the menu from the menu bar and returns the menu object - the caller Removes the menu from the menu bar and returns the menu object - the caller
@@ -351,7 +351,7 @@ public:
@see GetLabelTop() @see GetLabelTop()
*/ */
void SetLabelTop(int pos, const wxString& label); void SetLabelTop(size_t pos, const wxString& label);
/** /**
Sets the label of a top-level menu. Sets the label of a top-level menu.
@@ -363,7 +363,7 @@ public:
@remarks Use only after the menubar has been associated with a frame. @remarks Use only after the menubar has been associated with a frame.
*/ */
void SetMenuLabel(int pos, const wxString& label); virtual void SetMenuLabel(size_t pos, const wxString& label);
}; };
@@ -570,7 +570,7 @@ public:
@see Append(), InsertCheckItem() @see Append(), InsertCheckItem()
*/ */
wxMenuItem* AppendCheckItem(int id, const wxString& item, wxMenuItem* AppendCheckItem(int id, const wxString& item,
const wxString& helpString = ""); const wxString& help = wxEmptyString);
/** /**
Adds a radio item to the end of the menu. Adds a radio item to the end of the menu.
@@ -580,7 +580,7 @@ public:
@see Append(), InsertRadioItem() @see Append(), InsertRadioItem()
*/ */
wxMenuItem* AppendRadioItem(int id, const wxString& item, wxMenuItem* AppendRadioItem(int id, const wxString& item,
const wxString& helpString = ""); const wxString& help = wxEmptyString);
/** /**
Adds a separator to the end of the menu. Adds a separator to the end of the menu.
@@ -613,7 +613,7 @@ public:
@see IsChecked() @see IsChecked()
*/ */
void Check(int id, const bool check); void Check(int id, bool check);
/** /**
Deletes the menu item from the menu. If the item is a submenu, it will Deletes the menu item from the menu. If the item is a submenu, it will
@@ -671,7 +671,7 @@ public:
@see IsEnabled() @see IsEnabled()
*/ */
void Enable(int id, const bool enable); void Enable(int id, bool enable);
/** /**
Finds the menu id for a menu item string. Finds the menu id for a menu item string.
@@ -764,7 +764,7 @@ public:
@see SetTitle() @see SetTitle()
*/ */
wxString GetTitle() const; const wxString& GetTitle() const;
/** /**
Inserts the given @a item before the position @a pos. Inserts the given @a item before the position @a pos.
@@ -794,18 +794,16 @@ public:
@see Insert(), AppendCheckItem() @see Insert(), AppendCheckItem()
*/ */
wxMenuItem* InsertCheckItem(size_t pos, int id, wxMenuItem* InsertCheckItem(size_t pos, int id, const wxString& item,
const wxString& item, const wxString& helpString = wxEmptyString);
const wxString& helpString = "");
/** /**
Inserts a radio item at the given position. Inserts a radio item at the given position.
@see Insert(), AppendRadioItem() @see Insert(), AppendRadioItem()
*/ */
wxMenuItem* InsertRadioItem(size_t pos, int id, wxMenuItem* InsertRadioItem(size_t pos, int id, const wxString& item,
const wxString& item, const wxString& helpString = wxEmptyString);
const wxString& helpString = "");
/** /**
Inserts a separator at the given position. Inserts a separator at the given position.
@@ -862,7 +860,7 @@ public:
@see Prepend(), AppendCheckItem() @see Prepend(), AppendCheckItem()
*/ */
wxMenuItem* PrependCheckItem(int id, const wxString& item, wxMenuItem* PrependCheckItem(int id, const wxString& item,
const wxString& helpString = ""); const wxString& helpString = wxEmptyString);
/** /**
Inserts a radio item at position 0. Inserts a radio item at position 0.
@@ -870,7 +868,7 @@ public:
@see Prepend(), AppendRadioItem() @see Prepend(), AppendRadioItem()
*/ */
wxMenuItem* PrependRadioItem(int id, const wxString& item, wxMenuItem* PrependRadioItem(int id, const wxString& item,
const wxString& helpString = ""); const wxString& helpString = wxEmptyString);
/** /**
Inserts a separator at position 0. Inserts a separator at position 0.

View File

@@ -109,7 +109,7 @@ public:
/** /**
Returns the checked or unchecked bitmap (Windows only). Returns the checked or unchecked bitmap (Windows only).
*/ */
wxBitmap GetBitmap(bool checked = true) const; virtual const wxBitmap& GetBitmap() const;
/** /**
Returns the font associated with the menu item (Windows only). Returns the font associated with the menu item (Windows only).
@@ -119,7 +119,7 @@ public:
/** /**
Returns the help string associated with the menu item. Returns the help string associated with the menu item.
*/ */
wxString GetHelp() const; const wxString& GetHelp() const;
/** /**
Returns the menu item identifier. Returns the menu item identifier.
@@ -212,7 +212,7 @@ public:
@see GetLabel(), GetLabelFromText() @see GetLabel(), GetLabelFromText()
*/ */
wxString GetText() const; const wxString& GetText() const;
/** /**
Returns the text colour associated with the menu item (Windows only). Returns the text colour associated with the menu item (Windows only).
@@ -285,12 +285,12 @@ public:
/** /**
Sets the parent menu which will contain this menu item. Sets the parent menu which will contain this menu item.
*/ */
void SetMenu(const wxMenu* menu); void SetMenu(wxMenu* menu);
/** /**
Sets the submenu of this menu item. Sets the submenu of this menu item.
*/ */
void SetSubMenu(const wxMenu* menu); void SetSubMenu(wxMenu* menu);
/** /**
Sets the text associated with the menu item. Sets the text associated with the menu item.

View File

@@ -324,7 +324,7 @@ public:
This happens when one file extension is mapped to different MIME types This happens when one file extension is mapped to different MIME types
by KDE, mailcap and mime.types. by KDE, mailcap and mime.types.
*/ */
bool GetMimeType(wxArrayString& mimeTypes); bool GetMimeTypes(wxArrayString& mimeTypes) const;
//@{ //@{
/** /**
@@ -351,6 +351,7 @@ public:
The name of the file is retrieved from the MessageParameters class. The name of the file is retrieved from the MessageParameters class.
*/ */
bool GetPrintCommand(wxString* command, MessageParameters& params); bool GetPrintCommand(wxString* command,
const MessageParameters& params) const;
}; };

View File

@@ -103,11 +103,10 @@ public:
Used in two-step frame construction. Used in two-step frame construction.
See wxMiniFrame() for further details. See wxMiniFrame() for further details.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
const wxString& title,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxCAPTION | wxRESIZE_BORDER, long style = wxCAPTION | wxRESIZE_BORDER,
const wxString& name = "frame"); const wxString& name = wxFrameNameStr);
}; };

View File

@@ -96,12 +96,12 @@ public:
which don't support extended messages, it is simply appended to the which don't support extended messages, it is simply appended to the
normal message with a new line separating them. normal message with a new line separating them.
*/ */
void SetExtendedMessage(const wxString extendedMessage); virtual void SetExtendedMessage(const wxString& extendedMessage);
/** /**
Sets the message shown by the dialog. Sets the message shown by the dialog.
*/ */
void SetMessage(const wxString msg); virtual void SetMessage(const wxString& message);
/** /**
Overrides the default labels of the OK and Cancel buttons. Overrides the default labels of the OK and Cancel buttons.

View File

@@ -132,9 +132,8 @@ public:
@see GetPixel() @see GetPixel()
*/ */
bool GetRGB(int pixel, const unsigned char* red, bool GetRGB(int pixel, unsigned char* red, unsigned char* green,
const unsigned char* green, unsigned char* blue) const;
const unsigned char* blue) const;
/** /**
Returns @true if palette data is present. Returns @true if palette data is present.

View File

@@ -86,7 +86,7 @@ public:
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxTAB_TRAVERSAL, long style = wxTAB_TRAVERSAL,
const wxString& name = "panel"); const wxString& name = wxPanelNameStr);
/** /**
Sends a wxInitDialogEvent, which in turn transfers data to the dialog via Sends a wxInitDialogEvent, which in turn transfers data to the dialog via

View File

@@ -295,7 +295,7 @@ public:
@see GetDashes() @see GetDashes()
*/ */
virtual void SetDashes(int n, wxDash* dashes); virtual void SetDashes(int n, const wxDash* dash);
/** /**
Sets the pen join style, which may be one of @c wxJOIN_BEVEL, @c wxJOIN_ROUND Sets the pen join style, which may be one of @c wxJOIN_BEVEL, @c wxJOIN_ROUND
@@ -312,7 +312,7 @@ public:
@see GetStipple() @see GetStipple()
*/ */
virtual void SetStipple(wxBitmap* stipple); virtual void SetStipple(const wxBitmap& stipple);
/** /**
Set the pen style. Set the pen style.
@@ -339,7 +339,7 @@ public:
/** /**
Assignment operator, using @ref overview_refcount. Assignment operator, using @ref overview_refcount.
*/ */
wxPen operator =(const wxPen& pen); wxPen& operator=(const wxPen& pen);
/** /**
Equality operator. Equality operator.

View File

@@ -295,7 +295,7 @@ public:
The implementation simply blits the preview bitmap onto The implementation simply blits the preview bitmap onto
the canvas, creating a new preview bitmap if none exists. the canvas, creating a new preview bitmap if none exists.
*/ */
bool PaintPage(wxPreviewCanvas* canvas, wxDC dc); virtual bool PaintPage(wxPreviewCanvas* canvas, wxDC& dc);
/** /**
Invokes the print process using the second wxPrintout object Invokes the print process using the second wxPrintout object
@@ -321,7 +321,7 @@ public:
/** /**
Sets the current page to be previewed. Sets the current page to be previewed.
*/ */
void SetCurrentPage(int pageNum); virtual bool SetCurrentPage(int pageNum);
/** /**
Sets the frame to be used for displaying the print preview canvas Sets the frame to be used for displaying the print preview canvas
@@ -373,7 +373,7 @@ public:
/** /**
Creates the default printing abort window, with a cancel button. Creates the default printing abort window, with a cancel button.
*/ */
void CreateAbortWindow(wxWindow* parent, wxPrintout* printout); virtual wxWindow* CreateAbortWindow(wxWindow* parent, wxPrintout* printout);
/** /**
Returns @true if the user has aborted the print job. Returns @true if the user has aborted the print job.

View File

@@ -52,7 +52,7 @@ public:
Returns the @ref overview_printing_printdata "print dialog data" associated Returns the @ref overview_printing_printdata "print dialog data" associated
with the print dialog. with the print dialog.
*/ */
wxPrintDialogData GetPrintDialogData(); virtual wxPrintDialogData& GetPrintDialogData();
/** /**
Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c

View File

@@ -78,8 +78,7 @@ public:
(if present) to "Unknown" or to @a newmsg (if it's non-empty); moves the progress (if present) to "Unknown" or to @a newmsg (if it's non-empty); moves the progress
bar a bit to indicate that some progress was done. bar a bit to indicate that some progress was done.
*/ */
virtual bool Pulse(const wxString& newmsg = "", virtual bool Pulse(const wxString& newmsg = wxEmptyString, bool* skip = NULL);
bool* skip = NULL);
/** /**
Can be used to continue with the dialog, after the user had clicked the "Abort" button. Can be used to continue with the dialog, after the user had clicked the "Abort" button.

View File

@@ -127,12 +127,11 @@ public:
/** /**
Call this from your own Create function, before adding buttons and pages. Call this from your own Create function, before adding buttons and pages.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
const wxString& title,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxDEFAULT_DIALOG_STYLE, long style = wxDEFAULT_DIALOG_STYLE,
const wxString& name = "dialogBox"); const wxString& name = wxDialogNameStr);
/** /**
Override this if you wish to create a different kind of book control; by Override this if you wish to create a different kind of book control; by

View File

@@ -153,7 +153,7 @@ public:
@see GetFilesList() @see GetFilesList()
*/ */
bool GetDirList(wxArrayString& files, bool GetDirList(wxArrayString& files,
const wxString& wildcard = ""); const wxString& wildcard = wxEmptyString);
/** /**
Returns the file size in bytes or -1 if the file doesn't exist or the size Returns the file size in bytes or -1 if the file doesn't exist or the size
@@ -177,7 +177,7 @@ public:
@see GetDirList() @see GetDirList()
*/ */
bool GetFilesList(wxArrayString& files, bool GetFilesList(wxArrayString& files,
const wxString& wildcard = ""); const wxString& wildcard = wxEmptyString);
/** /**
Creates a new input stream on the specified path. Creates a new input stream on the specified path.
@@ -197,7 +197,7 @@ public:
/** /**
Returns the last command result, i.e. the full server reply for the last command. Returns the last command result, i.e. the full server reply for the last command.
*/ */
const wxString GetLastResult(); const wxString& GetLastResult();
/** /**
Initializes an output stream to the specified @e file. Initializes an output stream to the specified @e file.

View File

@@ -33,9 +33,9 @@ public:
Fills @a out_rows with indexes into palette (which is also stored into @a palette Fills @a out_rows with indexes into palette (which is also stored into @a palette
variable). variable).
*/ */
void DoQuantize(unsigned w, unsigned h, unsigned char** in_rows, static void DoQuantize(unsigned int w, unsigned int h,
unsigned char** out_rows, unsigned char* palette, unsigned char** in_rows, unsigned char** out_rows,
int desiredNoColours); unsigned char* palette, int desiredNoColours);
/** /**
Reduce the colours in the source image and put the result into the destination image. Reduce the colours in the source image and put the result into the destination image.

View File

@@ -194,7 +194,7 @@ public:
@param string @param string
The string to find. The string to find.
*/ */
int FindString(const wxString& string) const; virtual int FindString(const wxString& s, bool bCase = false) const;
/** /**
Returns the number of columns in the radiobox. Returns the number of columns in the radiobox.
@@ -208,7 +208,7 @@ public:
@param pt @param pt
Point in client coordinates. Point in client coordinates.
*/ */
int GetItemFromPoint(const wxPoint pt) const; virtual int GetItemFromPoint(const wxPoint& pt) const;
/** /**
Returns the helptext associated with the specified @a item if any or @c Returns the helptext associated with the specified @a item if any or @c

View File

@@ -94,13 +94,11 @@ public:
Creates the choice for two-step construction. See wxRadioButton() for Creates the choice for two-step construction. See wxRadioButton() for
further details. further details.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxString& label,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = 0,
long style = 0,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioButton"); const wxString& name = wxRadioButtonNameStr);
/** /**
Returns @true if the radio button is depressed, @false otherwise. Returns @true if the radio button is depressed, @false otherwise.
@@ -114,6 +112,6 @@ public:
@param value @param value
@true to select, @false to deselect. @true to select, @false to deselect.
*/ */
void SetValue(const bool value); virtual void SetValue(bool value);
}; };

View File

@@ -427,7 +427,7 @@ public:
/** /**
Assignment operator, using @ref overview_refcount. Assignment operator, using @ref overview_refcount.
*/ */
void operator =(const wxRegion& region); wxRegion& operator=(const wxRegion& region);
}; };
/** /**

View File

@@ -293,8 +293,8 @@ public:
@a flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or @a flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or
@c wxCONTROL_UNDETERMINED bit set, see @ref wxCONTROL_FLAGS. @c wxCONTROL_UNDETERMINED bit set, see @ref wxCONTROL_FLAGS.
*/ */
virtual void DrawCheckBox(wxWindow* win, wxDC& dc, virtual void DrawCheckBox(wxWindow* win, wxDC& dc, const wxRect& rect,
const wxRect& rect, int flags); int flags = 0) = 0;
/** /**
Draw a button like the one used by wxComboBox to show a Draw a button like the one used by wxComboBox to show a
@@ -304,8 +304,7 @@ public:
see @ref wxCONTROL_FLAGS. see @ref wxCONTROL_FLAGS.
*/ */
virtual void DrawComboBoxDropButton(wxWindow* win, wxDC& dc, virtual void DrawComboBoxDropButton(wxWindow* win, wxDC& dc,
const wxRect& rect, const wxRect& rect, int flags = 0) = 0;
int flags);
/** /**
Draw a drop down arrow that is suitable for use outside a combo box. Arrow will Draw a drop down arrow that is suitable for use outside a combo box. Arrow will
@@ -318,7 +317,7 @@ public:
see @ref wxCONTROL_FLAGS. see @ref wxCONTROL_FLAGS.
*/ */
virtual void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect, virtual void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags); int flags = 0) = 0;
/** /**
Draw a focus rectangle using the specified rectangle. Draw a focus rectangle using the specified rectangle.
@@ -380,8 +379,8 @@ public:
@a flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or @a flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or
@c wxCONTROL_ISDEFAULT bit set, see @ref wxCONTROL_FLAGS. @c wxCONTROL_ISDEFAULT bit set, see @ref wxCONTROL_FLAGS.
*/ */
virtual void DrawPushButton(wxWindow* win, wxDC& dc, virtual void DrawPushButton(wxWindow* win, wxDC& dc, const wxRect& rect,
const wxRect& rect, int flags); int flags = 0) = 0;
/** /**
Draw the border for sash window: this border must be such that the sash Draw the border for sash window: this border must be such that the sash

View File

@@ -157,10 +157,9 @@ public:
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = wxSB_HORIZONTAL,
long style = wxSB_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "scrollBar"); const wxString& name = wxScrollBarNameStr);
/** /**
Returns the page size of the scrollbar. Returns the page size of the scrollbar.

View File

@@ -176,13 +176,11 @@ public:
Used for two-step slider construction. Used for two-step slider construction.
See wxSlider() for further details. See wxSlider() for further details.
*/ */
bool Create(wxWindow* parent, wxWindowID id, int value, bool Create(wxWindow* parent, wxWindowID id, int value, int minValue,
int minValue, int maxValue, int maxValue, const wxPoint& point = wxDefaultPosition,
const wxPoint& point = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxSL_HORIZONTAL,
const wxSize& size = wxDefaultSize,
long style = wxSL_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "slider"); const wxString& name = wxSliderNameStr);
/** /**
Returns the line size. Returns the line size.

View File

@@ -91,13 +91,12 @@ public:
Creation function called by the spin control constructor. Creation function called by the spin control constructor.
See wxSpinCtrl() for details. See wxSpinCtrl() for details.
*/ */
bool Create(wxWindow* parent, wxWindowID id = -1, bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxString& value = wxEmptyString, const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxSP_ARROW_KEYS, long style = wxSP_ARROW_KEYS, int min = 0, int max = 100,
int min = 0, int max = 100, int initial = 0, const wxString& name = "wxSpinCtrl");
int initial = 0, const wxString& name = _T("wxSpinCtrl"));
/** /**
Gets maximal allowable value. Gets maximal allowable value.

View File

@@ -61,12 +61,10 @@ public:
/** /**
Creation function, for two-step construction. For details see wxStaticBitmap(). Creation function, for two-step construction. For details see wxStaticBitmap().
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxBitmap& label,
const wxBitmap& label,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = 0,
long style = 0, const wxString& name = wxStaticBitmapNameStr);
const wxString& name = "staticBitmap");
/** /**
Returns the bitmap currently used in the control. Returns the bitmap currently used in the control.

View File

@@ -81,12 +81,10 @@ public:
/** /**
Creation function, for two-step construction. For details see wxStaticText(). Creation function, for two-step construction. For details see wxStaticText().
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxString& label,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = 0,
long style = 0, const wxString& name = wxStaticTextNameStr);
const wxString& name = "staticText");
/** /**
Returns the contents of the control. Returns the contents of the control.

View File

@@ -69,7 +69,7 @@ public:
*/ */
bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
long style = wxST_SIZEGRIP, long style = wxST_SIZEGRIP,
const wxString& name = "statusBar"); const wxString& name = wxStatusBarNameStr);
/** /**
Returns the size and position of a field's internal bounding rectangle. Returns the size and position of a field's internal bounding rectangle.
@@ -126,7 +126,7 @@ public:
An array of n integers interpreted in the same way as An array of n integers interpreted in the same way as
in SetStatusWidths(). in SetStatusWidths().
*/ */
virtual void SetFieldsCount(int number = 1, int* widths = NULL); virtual void SetFieldsCount(int number = 1, const int* widths = NULL);
/** /**
Sets the minimal possible height for the status bar. Sets the minimal possible height for the status bar.
@@ -150,7 +150,7 @@ public:
- wxSB_FLAT: No border is painted around the field so that it appears flat. - wxSB_FLAT: No border is painted around the field so that it appears flat.
- wxSB_RAISED: A raised 3D border is painted around the field. - wxSB_RAISED: A raised 3D border is painted around the field.
*/ */
virtual void SetStatusStyles(int n, int* styles); virtual void SetStatusStyles(int n, const int* styles);
/** /**
Sets the text for one field. Sets the text for one field.
@@ -191,6 +191,6 @@ public:
@see SetFieldsCount(), wxFrame::SetStatusWidths() @see SetFieldsCount(), wxFrame::SetStatusWidths()
*/ */
virtual void SetStatusWidths(int n, int* widths); virtual void SetStatusWidths(int n, const int* widths_field);
}; };

View File

@@ -934,12 +934,12 @@ public:
/** /**
*/ */
wxString GetCurLine(int* OUTPUT); wxString GetCurLine(int* linePos = NULL);
/** /**
*/ */
wxCharBuffer GetCurLineRaw(int* OUTPUT); wxCharBuffer GetCurLineRaw(int* linePos = NULL);
/** /**
END of generated section END of generated section
@@ -1022,7 +1022,7 @@ public:
/** /**
Are the indentation guides visible? Are the indentation guides visible?
*/ */
bool GetIndentationGuides(); int GetIndentationGuides() const;
/** /**
Find the last child line of a header line. Find the last child line of a header line.
@@ -1626,7 +1626,7 @@ public:
/** /**
Load the contents of filename into the editor Load the contents of filename into the editor
*/ */
bool LoadFile(const wxString& filename); bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY);
/** /**
Transform the selection to lower case. Transform the selection to lower case.
@@ -1847,7 +1847,7 @@ public:
/** /**
Write the contents of the editor to filename Write the contents of the editor to filename
*/ */
bool SaveFile(const wxString& filename); bool SaveFile(const wxString& file = wxEmptyString, int fileType = wxTEXT_TYPE_ANY);
/** /**
Scroll enough to make the given column visible Scroll enough to make the given column visible
@@ -1903,7 +1903,7 @@ public:
/** /**
Send a message to Scintilla Send a message to Scintilla
*/ */
long SendMsg(int msg, long wp = 0, long lp = 0); wxIntPtr SendMsg(int msg, wxUIntPtr wp = 0, wxIntPtr lp = 0) const;
/** /**
Set the selection anchor to a position. The anchor is the opposite Set the selection anchor to a position. The anchor is the opposite
@@ -2080,7 +2080,7 @@ public:
/** /**
Show or hide indentation guides. Show or hide indentation guides.
*/ */
void SetIndentationGuides(bool show); void SetIndentationGuides(int indentView);
/** /**
Set up the key words used by the lexer. Set up the key words used by the lexer.
@@ -2246,7 +2246,7 @@ public:
/** /**
Select a range of text. Select a range of text.
*/ */
void SetSelection(int start, int end); virtual void SetSelection(long from, long to);
/** /**
Sets the position that ends the selection - this becomes the currentPosition. Sets the position that ends the selection - this becomes the currentPosition.

View File

@@ -126,8 +126,8 @@ public:
@since 2.7.0 @since 2.7.0
*/ */
wxString GetLocalizedResourcesDir(const wxString& lang, virtual wxString GetLocalizedResourcesDir(const wxString& lang,
ResourceCat category = ResourceCat_None) const; ResourceCat category) const;
/** /**
Return the directory where the loadable modules (plugins) live. Return the directory where the loadable modules (plugins) live.

View File

@@ -116,7 +116,8 @@ public:
/** /**
Sets the icon, and optional tooltip text. Sets the icon, and optional tooltip text.
*/ */
bool SetIcon(const wxIcon& icon, const wxString& tooltip); virtual bool SetIcon(const wxIcon& icon,
const wxString& tooltip = wxEmptyString);
/** /**
Returns true if system tray is available in the desktop environment the Returns true if system tray is available in the desktop environment the

View File

@@ -256,12 +256,12 @@ public:
Returns the bullet text, which could be a symbol, or (for example) cached Returns the bullet text, which could be a symbol, or (for example) cached
outline text. outline text.
*/ */
const wxString GetBulletText() const; const wxString& GetBulletText() const;
/** /**
Returns the name of the character style. Returns the name of the character style.
*/ */
const wxString GetCharacterStyleName() const; const wxString& GetCharacterStyleName() const;
/** /**
Returns flags indicating which attributes are applicable. Returns flags indicating which attributes are applicable.
@@ -293,7 +293,7 @@ public:
/** /**
Returns the font face name. Returns the font face name.
*/ */
const wxString GetFontFaceName() const; const wxString& GetFontFaceName() const;
/** /**
Returns the font size in points. Returns the font size in points.
@@ -333,12 +333,12 @@ public:
/** /**
Returns the name of the list style. Returns the name of the list style.
*/ */
const wxString GetListStyleName() const; const wxString& GetListStyleName() const;
/** /**
Returns the outline level. Returns the outline level.
*/ */
bool GetOutlineLevel() const; int GetOutlineLevel() const;
/** /**
Returns the space in tenths of a millimeter after the paragraph. Returns the space in tenths of a millimeter after the paragraph.
@@ -353,7 +353,7 @@ public:
/** /**
Returns the name of the paragraph style. Returns the name of the paragraph style.
*/ */
const wxString GetParagraphStyleName() const; const wxString& GetParagraphStyleName() const;
/** /**
Returns the right indent in tenths of a millimeter. Returns the right indent in tenths of a millimeter.
@@ -366,12 +366,12 @@ public:
Each stop is measured from the left margin and therefore each value must Each stop is measured from the left margin and therefore each value must
be larger than the last. be larger than the last.
*/ */
const wxArrayInt GetTabs() const; const wxArrayInt& GetTabs() const;
/** /**
Returns the text foreground colour. Returns the text foreground colour.
*/ */
const wxColour GetTextColour() const; const wxColour& GetTextColour() const;
/** /**
Returns the text effect bits of interest. Returns the text effect bits of interest.
@@ -392,7 +392,7 @@ public:
hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent
when the content is clicked. when the content is clicked.
*/ */
const wxString GetURL() const; const wxString& GetURL() const;
/** /**
Returns @true if the attribute object specifies alignment. Returns @true if the attribute object specifies alignment.
@@ -616,7 +616,7 @@ public:
Sets the bullet text, which could be a symbol, or (for example) cached Sets the bullet text, which could be a symbol, or (for example) cached
outline text. outline text.
*/ */
void SetBulletText(const wxString text); void SetBulletText(const wxString& text);
/** /**
Sets the character style name. Sets the character style name.
@@ -633,7 +633,7 @@ public:
Sets the attributes for the given font. Sets the attributes for the given font.
Note that wxTextAttr does not store an actual wxFont object. Note that wxTextAttr does not store an actual wxFont object.
*/ */
void SetFont(const wxFont& font); void SetFont(const wxFont& font, int flags = wxTEXT_ATTR_FONT);
/** /**
Sets the font encoding. Sets the font encoding.
@@ -1181,10 +1181,9 @@ public:
non-default constructor. non-default constructor.
*/ */
bool Create(wxWindow* parent, wxWindowID id, bool Create(wxWindow* parent, wxWindowID id,
const wxString& value = "", const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize, long style = 0,
long style = 0,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxTextCtrlNameStr); const wxString& name = wxTextCtrlNameStr);
@@ -1217,7 +1216,7 @@ public:
@see SetDefaultStyle() @see SetDefaultStyle()
*/ */
const wxTextAttr GetDefaultStyle() const; virtual const wxTextAttr& GetDefaultStyle() const;
/** /**
Returns the insertion point, or cursor, position. Returns the insertion point, or cursor, position.
@@ -1508,7 +1507,7 @@ public:
@return @return
@true if the operation was successful, @false otherwise. @true if the operation was successful, @false otherwise.
*/ */
bool SaveFile(const wxString& filename, bool SaveFile(const wxString& filename = wxEmptyString,
int fileType = wxTEXT_TYPE_ANY); int fileType = wxTEXT_TYPE_ANY);
/** /**
@@ -1545,7 +1544,7 @@ public:
@see IsEditable() @see IsEditable()
*/ */
virtual void SetEditable(const bool editable); virtual void SetEditable(bool editable);
/** /**
Sets the insertion point at the given position. Sets the insertion point at the given position.

View File

@@ -85,7 +85,7 @@ public:
Adds a line to the end of file. Adds a line to the end of file.
*/ */
void AddLine(const wxString& str, void AddLine(const wxString& str,
wxTextFileType type = typeDefault) const; wxTextFileType type = wxTextBuffer::typeDefault);
/** /**
Delete all lines from the file, set current line number to 0. Delete all lines from the file, set current line number to 0.
@@ -154,7 +154,7 @@ public:
// do something with the last line in str // do something with the last line in str
@endcode @endcode
*/ */
wxString GetFirstLine() const; wxString& GetFirstLine();
/** /**
Gets the last line of the file. Gets the last line of the file.
@@ -174,7 +174,7 @@ public:
// do something with the first line in str // do something with the first line in str
@endcode @endcode
*/ */
wxString GetLastLine(); wxString& GetLastLine();
/** /**
Retrieves the line number @a n from the file. Retrieves the line number @a n from the file.
@@ -182,7 +182,7 @@ public:
The returned line may be modified but you shouldn't add line terminator The returned line may be modified but you shouldn't add line terminator
at the end - this will be done by wxTextFile. at the end - this will be done by wxTextFile.
*/ */
wxString GetLine(size_t n) const; wxString& GetLine(size_t n) const;
/** /**
Get the number of lines in the file. Get the number of lines in the file.
@@ -197,17 +197,17 @@ public:
/** /**
Get the name of the file. Get the name of the file.
*/ */
const char* GetName() const; const wxString& GetName() const;
/** /**
Gets the next line (see GetFirstLine() for the example). Gets the next line (see GetFirstLine() for the example).
*/ */
wxString GetNextLine(); wxString& GetNextLine();
/** /**
Gets the previous line in the file. Gets the previous line in the file.
*/ */
wxString GetPrevLine(); wxString& GetPrevLine();
/** /**
Changes the value returned by GetCurrentLine() and used by GetFirstLine() Changes the value returned by GetCurrentLine() and used by GetFirstLine()
@@ -228,7 +228,7 @@ public:
Insert a line before the line number @a n. Insert a line before the line number @a n.
*/ */
void InsertLine(const wxString& str, size_t n, void InsertLine(const wxString& str, size_t n,
wxTextFileType type = typeDefault) const; wxTextFileType type = wxTextBuffer::typeDefault);
/** /**
Returns @true if the file is currently opened. Returns @true if the file is currently opened.
@@ -274,6 +274,6 @@ public:
/** /**
The same as GetLine(). The same as GetLine().
*/ */
wxString operator[](size_t n) const; wxString& operator[](size_t n) const;
}; };

View File

@@ -115,7 +115,7 @@ public:
GetNextToken() is called and when it reaches 0, HasMoreTokens() GetNextToken() is called and when it reaches 0, HasMoreTokens()
returns @false. returns @false.
*/ */
int CountTokens() const; size_t CountTokens() const;
/** /**
Returns the delimiter which ended scan for the last token returned by Returns the delimiter which ended scan for the last token returned by

View File

@@ -178,12 +178,11 @@ public:
@see AddTool() @see AddTool()
*/ */
wxToolBarToolBase* AddCheckTool(int toolId, wxToolBarToolBase* AddCheckTool(int toolId, const wxString& label,
const wxString& label,
const wxBitmap& bitmap1, const wxBitmap& bitmap1,
const wxBitmap& bitmap2, const wxBitmap& bmpDisabled = wxNullBitmap,
const wxString& shortHelpString = "", const wxString& shortHelp = wxEmptyString,
const wxString& longHelpString = "", const wxString& longHelp = wxEmptyString,
wxObject* clientData = NULL); wxObject* clientData = NULL);
/** /**
@@ -202,7 +201,8 @@ public:
wxMac: labels are only displayed if wxWidgets is built with @c wxMac: labels are only displayed if wxWidgets is built with @c
wxMAC_USE_NATIVE_TOOLBAR set to 1 wxMAC_USE_NATIVE_TOOLBAR set to 1
*/ */
bool AddControl(wxControl* control, const wxString label = ""); virtual wxToolBarToolBase* AddControl(wxControl* control,
const wxString& label = wxEmptyString);
/** /**
Adds a new radio tool to the toolbar. Consecutive radio tools form a Adds a new radio tool to the toolbar. Consecutive radio tools form a
@@ -218,12 +218,11 @@ public:
@see AddTool() @see AddTool()
*/ */
wxToolBarToolBase* AddRadioTool(int toolId, wxToolBarToolBase* AddRadioTool(int toolId, const wxString& label,
const wxString& label,
const wxBitmap& bitmap1, const wxBitmap& bitmap1,
const wxBitmap& bitmap2, const wxBitmap& bmpDisabled = wxNullBitmap,
const wxString& shortHelpString = "", const wxString& shortHelp = wxEmptyString,
const wxString& longHelpString = "", const wxString& longHelp = wxEmptyString,
wxObject* clientData = NULL); wxObject* clientData = NULL);
/** /**
@@ -231,7 +230,7 @@ public:
@see AddTool(), SetToolSeparation() @see AddTool(), SetToolSeparation()
*/ */
void AddSeparator(); virtual wxToolBarToolBase* AddSeparator();
/** /**
Adds a tool to the toolbar. Adds a tool to the toolbar.
@@ -498,7 +497,7 @@ public:
/** /**
Returns the number of tools in the toolbar. Returns the number of tools in the toolbar.
*/ */
int GetToolsCount() const; size_t GetToolsCount() const;
/** /**
Inserts the control into the toolbar at the given position. You must Inserts the control into the toolbar at the given position. You must
@@ -506,7 +505,8 @@ public:
@see AddControl(), InsertTool() @see AddControl(), InsertTool()
*/ */
wxToolBarToolBase* InsertControl(size_t pos, wxControl* control); virtual wxToolBarToolBase* InsertControl(size_t pos, wxControl* control,
const wxString& label = wxEmptyString);
/** /**
Inserts the separator into the toolbar at the given position. You must Inserts the separator into the toolbar at the given position. You must
@@ -593,7 +593,7 @@ public:
@see OnMouseEnter(), OnLeftClick() @see OnMouseEnter(), OnLeftClick()
*/ */
void OnRightClick(int toolId, float x, float y); virtual void OnRightClick(int toolId, long x, long y);
/** /**
This function should be called after you have added tools. This function should be called after you have added tools.

View File

@@ -100,7 +100,7 @@ public:
/** /**
Clones the generic validator using the copy constructor. Clones the generic validator using the copy constructor.
*/ */
virtual wxValidator* Clone() const; virtual wxObject* Clone() const;
/** /**
Transfers the value from the window to the appropriate data type. Transfers the value from the window to the appropriate data type.

View File

@@ -69,7 +69,7 @@ public:
/** /**
Clones the text validator using the copy constructor. Clones the text validator using the copy constructor.
*/ */
virtual wxValidator* Clone() const; virtual wxObject* Clone() const;
/** /**
Returns a reference to the exclude list (the list of invalid values). Returns a reference to the exclude list (the list of invalid values).