ifacecheck fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56549 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-28 14:29:36 +00:00
parent 9e570f836b
commit cfbe561401
9 changed files with 82 additions and 98 deletions

View File

@@ -99,7 +99,7 @@ public:
@see GetIcons() @see GetIcons()
*/ */
const wxIcon GetIcon() const; wxIcon GetIcon() const;
/** /**
Returns all icons associated with the window, there will be none of them Returns all icons associated with the window, there will be none of them
@@ -108,7 +108,7 @@ public:
@see wxIconBundle @see wxIconBundle
*/ */
const wxIconBundle GetIcons() const; const wxIconBundle& GetIcons() const;
/** /**
Gets a string containing the window title. Gets a string containing the window title.
@@ -133,7 +133,7 @@ public:
@see IsIconized(), Maximize(), wxIconizeEvent. @see IsIconized(), Maximize(), wxIconizeEvent.
*/ */
void Iconize(bool iconize); virtual void Iconize(bool iconize = true);
/** /**
Returns @true if this window is currently active, i.e. if the user is Returns @true if this window is currently active, i.e. if the user is
@@ -184,7 +184,7 @@ public:
@see Iconize() @see Iconize()
*/ */
void Maximize(bool maximize); virtual void Maximize(bool maximize = true);
/** /**
Use a system-dependent way to attract users attention to the window when Use a system-dependent way to attract users attention to the window when
@@ -210,7 +210,7 @@ public:
@see GetDefaultItem() @see GetDefaultItem()
*/ */
void SetDefaultItem(wxWindow* win); wxWindow* SetDefaultItem(wxWindow* win);
/** /**
Sets the icon for this window. Sets the icon for this window.
@@ -368,7 +368,7 @@ public:
fully transparent, and a value of 255 sets the window to be fully fully transparent, and a value of 255 sets the window to be fully
opaque. opaque.
*/ */
virtual bool SetTransparent(int alpha); virtual bool SetTransparent(wxByte alpha);
/** /**
This virtual function is not meant to be called directly but can be This virtual function is not meant to be called directly but can be

View File

@@ -88,7 +88,7 @@ public:
/** /**
Returns the item associated with this node. Returns the item associated with this node.
*/ */
const wxTreeItemId GetId(); const wxTreeItemId& GetId() const;
/** /**
Sets the item associated with this node. Sets the item associated with this node.

View File

@@ -155,12 +155,12 @@ public:
@see Create(), wxValidator @see Create(), wxValidator
*/ */
wxTreeCtrl(wxWindow* parent, wxWindowID id, wxTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = wxTR_HAS_BUTTONS, long style = wxTR_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "treeCtrl"); const wxString& name = wxTreeCtrlNameStr);
/** /**
@@ -253,15 +253,15 @@ public:
virtual void CollapseAndReset(const wxTreeItemId& item); virtual void CollapseAndReset(const wxTreeItemId& item);
/** /**
Creates the tree control. See wxTreeCtrl::wxTreeCtrl() for further Creates the tree control.
details. See wxTreeCtrl::wxTreeCtrl() for further details.
*/ */
bool Create(wxWindow* 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 = wxTR_HAS_BUTTONS, long style = wxTR_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "treeCtrl"); const wxString& name = wxTreeCtrlNameStr);
/** /**
Deletes the specified item. A EVT_TREE_DELETE_ITEM() event will be Deletes the specified item. A EVT_TREE_DELETE_ITEM() event will be
@@ -298,7 +298,8 @@ public:
@see EndEditLabel(), wxTreeEvent @see EndEditLabel(), wxTreeEvent
*/ */
void EditLabel(const wxTreeItemId& item); virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
/** /**
Ends label editing. If @a cancelEdit is @true, the edit will be Ends label editing. If @a cancelEdit is @true, the edit will be
@@ -309,7 +310,7 @@ public:
@see EditLabel() @see EditLabel()
*/ */
void EndEditLabel(bool cancelEdit); virtual void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);
/** /**
Scrolls and/or expands items to ensure that the given item is visible. Scrolls and/or expands items to ensure that the given item is visible.
@@ -366,7 +367,7 @@ public:
returns the total number of descendants, otherwise only one level of returns the total number of descendants, otherwise only one level of
children is counted. children is counted.
*/ */
unsigned int GetChildrenCount(const wxTreeItemId& item, virtual size_t GetChildrenCount(const wxTreeItemId& item,
bool recursively = true) const; bool recursively = true) const;
/** /**
@@ -417,7 +418,7 @@ public:
/** /**
Returns the current tree control indentation. Returns the current tree control indentation.
*/ */
int GetIndent() const; virtual unsigned int GetIndent() const;
/** /**
Returns the background colour of the item. Returns the background colour of the item.
@@ -462,13 +463,6 @@ public:
*/ */
virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const; virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
/**
Gets the selected item image (this function is obsolete, use @ref
GetItemImage() "GetItemImage"( @a item, ::wxTreeItemIcon_Selected)
instead).
*/
int GetItemSelectedImage(const wxTreeItemId& item) const;
/** /**
Gets the specified item state. Gets the specified item state.
*/ */
@@ -580,7 +574,7 @@ public:
Python list of @ref wxTreeItemId "wxTreeItemId"s. Python list of @ref wxTreeItemId "wxTreeItemId"s.
@endWxPythonOnly @endWxPythonOnly
*/ */
unsigned int GetSelections(wxArrayTreeItemIds& selection) const; virtual size_t GetSelections(wxArrayTreeItemIds& selection) const;
/** /**
Returns the state image list (from which application-defined state Returns the state image list (from which application-defined state
@@ -756,7 +750,7 @@ public:
/** /**
Sets the indentation for the tree control. Sets the indentation for the tree control.
*/ */
void SetIndent(int indent); virtual void SetIndent(unsigned int indent);
/** /**
Sets the colour of the item's background. Sets the colour of the item's background.
@@ -818,13 +812,6 @@ public:
virtual void SetItemImage(const wxTreeItemId& item, int image, virtual void SetItemImage(const wxTreeItemId& item, int image,
wxTreeItemIcon which = wxTreeItemIcon_Normal); wxTreeItemIcon which = wxTreeItemIcon_Normal);
/**
Sets the selected item image (this function is obsolete, use @ref
SetItemImage() "SetItemImage"( @a item, ::wxTreeItemIcon_Selected )
instead).
*/
void SetItemSelectedImage(const wxTreeItemId& item, int selImage);
/** /**
Sets the specified item state. The value of @a state may be: Sets the specified item state. The value of @a state may be:
- @c wxTREE_ITEMSTATE_NONE: to disable the item state (the state image will - @c wxTREE_ITEMSTATE_NONE: to disable the item state (the state image will
@@ -980,7 +967,8 @@ public:
/** /**
Constructor, used by wxWidgets itself only. Constructor, used by wxWidgets itself only.
*/ */
wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree); wxTreeEvent(wxEventType commandType, wxTreeCtrl* tree,
const wxTreeItemId& item = wxTreeItemId());
/** /**
Returns the item (valid for all events). Returns the item (valid for all events).
@@ -996,12 +984,12 @@ public:
/** /**
Returns the key event for EVT_TREE_KEY_DOWN() events. Returns the key event for EVT_TREE_KEY_DOWN() events.
*/ */
const wxKeyEvent GetKeyEvent() const; const wxKeyEvent& GetKeyEvent() const;
/** /**
Returns the label if the event is a begin or end edit label event. Returns the label if the event is a begin or end edit label event.
*/ */
const wxString GetLabel() const; const wxString& GetLabel() const;
/** /**
Returns the old item index (valid for EVT_TREE_ITEM_CHANGING() and Returns the old item index (valid for EVT_TREE_ITEM_CHANGING() and

View File

@@ -67,13 +67,15 @@ public:
Creates an empty URI. Creates an empty URI.
*/ */
wxURI(); wxURI();
/** /**
Constructor for quick creation. Constructor for quick creation.
@param uri @param uri
URI (Uniform Resource Identifier) to initialize with. URI (Uniform Resource Identifier) to initialize with.
*/ */
wxURI(const wxChar* uri); wxURI(const wxString& uri);
/** /**
Copies this URI from another URI. Copies this URI from another URI.
@@ -104,13 +106,12 @@ public:
/** /**
Creates this URI from the @a uri string. Creates this URI from the @a uri string.
Returns the position at which parsing stopped (there is no such thing Returns @true if this instance was correctly initialized.
as an "invalid" wxURI).
@param uri @param uri
String to initialize from. String to initialize from.
*/ */
const wxChar* Create(const wxString uri); bool Create(const wxString& uri);
/** /**
Obtains the fragment of this URI. Obtains the fragment of this URI.
@@ -125,7 +126,7 @@ public:
/** /**
Obtains the host type of this URI, which is one of wxURIHostType. Obtains the host type of this URI, which is one of wxURIHostType.
*/ */
const wxURIHostType& GetHostType() const; wxURIHostType GetHostType() const;
/** /**
Returns the password part of the userinfo component of this URI. Note Returns the password part of the userinfo component of this URI. Note
@@ -134,7 +135,7 @@ public:
@c "http://<user>:<password>@mysite.com/mypath" @c "http://<user>:<password>@mysite.com/mypath"
*/ */
const wxString& GetPassword() const; wxString GetPassword() const;
/** /**
Returns the (normalized) path of the URI. Returns the (normalized) path of the URI.
@@ -199,7 +200,7 @@ public:
@c "http://<user>:<password>@mysite.com/mypath" @c "http://<user>:<password>@mysite.com/mypath"
*/ */
const wxString& GetUser() const; wxString GetUser() const;
/** /**
Returns the UserInfo component of the URI. Returns the UserInfo component of the URI.
@@ -293,6 +294,6 @@ public:
@param uricomp @param uricomp
URI to compare to. URI to compare to.
*/ */
void operator ==(const wxURI& uricomp); bool operator==(const wxURI& uricomp) const;
}; };

View File

@@ -94,7 +94,7 @@ public:
/** /**
Returns a reference to the protocol which will be used to get the URL. Returns a reference to the protocol which will be used to get the URL.
*/ */
wxProtocol GetProtocol(); wxProtocol& GetProtocol();
/** /**
Returns @true if this object is correctly initialized, i.e. if Returns @true if this object is correctly initialized, i.e. if

View File

@@ -106,28 +106,28 @@ public:
/** /**
Constructs a string from @a n characters @a ch. Constructs a string from @a n characters @a ch.
*/ */
wxUString( size_type n, char ch ); wxUString( size_t n, char ch );
/** /**
Constructs a string from @a n characters @a ch. Constructs a string from @a n characters @a ch.
*/ */
wxUString( size_type n, wxChar16 ch ); wxUString( size_t n, wxChar16 ch );
/** /**
Constructs a string from @a n characters @a ch. Constructs a string from @a n characters @a ch.
*/ */
wxUString( size_type n, wxChar32 ch ); wxUString( size_t n, wxChar32 ch );
/** /**
Constructs a string from @a n characters @a ch. Constructs a string from @a n characters @a ch.
*/ */
wxUString( size_type n, wxUniChar ch ); wxUString( size_t n, wxUniChar ch );
/** /**
Constructs a string from @a n characters @a ch. Constructs a string from @a n characters @a ch.
*/ */
wxUString( size_type n, wxUniCharRef ch ); wxUString( size_t n, wxUniCharRef ch );
/** /**
Static construction of a wxUString from a 7-bit ASCII string Static construction of a wxUString from a 7-bit ASCII string
*/ */
static wxUString FromAscii( const char *str, size_type n ); static wxUString FromAscii( const char *str, size_t n );
/** /**
Static construction of a wxUString from a 7-bit ASCII string Static construction of a wxUString from a 7-bit ASCII string
*/ */
@@ -135,7 +135,7 @@ public:
/** /**
Static construction of a wxUString from a UTF-8 encoded string Static construction of a wxUString from a UTF-8 encoded string
*/ */
static wxUString FromUTF8( const char *str, size_type n ); static wxUString FromUTF8( const char *str, size_t n );
/** /**
Static construction of a wxUString from a UTF-8 encoded string Static construction of a wxUString from a UTF-8 encoded string
*/ */
@@ -143,7 +143,7 @@ public:
/** /**
Static construction of a wxUString from a UTF-16 encoded string Static construction of a wxUString from a UTF-16 encoded string
*/ */
static wxUString FromUTF16( const wxChar16 *str, size_type n ); static wxUString FromUTF16( const wxChar16 *str, size_t n );
/** /**
Static construction of a wxUString from a UTF-16 encoded string Static construction of a wxUString from a UTF-16 encoded string
*/ */
@@ -157,7 +157,7 @@ public:
/** /**
Assigment from a 7-bit ASCII string literal Assigment from a 7-bit ASCII string literal
*/ */
wxUString &assignFromAscii( const char *str, size_type n ); wxUString &assignFromAscii( const char *str, size_t n );
/** /**
Assigment from a UTF-8 string literal Assigment from a UTF-8 string literal
*/ */
@@ -165,7 +165,7 @@ public:
/** /**
Assigment from a UTF-8 string literal Assigment from a UTF-8 string literal
*/ */
wxUString &assignFromUTF8( const char *str, size_type n ); wxUString &assignFromUTF8( const char *str, size_t n );
/** /**
Assigment from a UTF-16 string literal Assigment from a UTF-16 string literal
*/ */
@@ -173,7 +173,7 @@ public:
/** /**
Assigment from a UTF-16 string literal Assigment from a UTF-16 string literal
*/ */
wxUString &assignFromUTF16( const wxChar16* str, size_type n ); wxUString &assignFromUTF16( const wxChar16* str, size_t n );
/** /**
Assigment from a C string literal using wxConvLibc Assigment from a C string literal using wxConvLibc
*/ */
@@ -222,7 +222,7 @@ public:
wxString, C string, UTF-16 strings, 32-bit strings, char buffers, wxString, C string, UTF-16 strings, 32-bit strings, char buffers,
single characters etc. single characters etc.
*/ */
wxUString &insert( size_type pos, const wxUString &s ); wxUString &insert( size_t pos, const wxUString &s );
/** /**
Assignment operator. wxUString additionally provides overloads for Assignment operator. wxUString additionally provides overloads for

View File

@@ -160,12 +160,12 @@ public:
/** /**
Constructs a variant from a wxDateTime. Constructs a variant from a wxDateTime.
*/ */
wxVariant(wxDateTime& val, const wxString& name = wxEmptyString); wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString);
/** /**
Constructs a variant from a wxArrayString. Constructs a variant from a wxArrayString.
*/ */
wxVariant(wxArrayString& val, const wxString& name = wxEmptyString); wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
/** /**
Destructor. Destructor.
@@ -266,7 +266,7 @@ public:
/** /**
Returns the character value. Returns the character value.
*/ */
wxChar GetChar() const; wxUniChar GetChar() const;
/** /**
Returns a pointer to the internal variant data. To take ownership of Returns a pointer to the internal variant data. To take ownership of
@@ -293,7 +293,7 @@ public:
/** /**
Returns a constant reference to the variant name. Returns a constant reference to the variant name.
*/ */
const wxString GetName() const; const wxString& GetName() const;
/** /**
Gets the string value. Gets the string value.
@@ -536,7 +536,8 @@ public:
/** /**
Reads the data from @a stream. Reads the data from @a stream.
*/ */
bool Read(ostream& stream); virtual bool Read(istream& stream);
/** /**
Reads the data from @a string. Reads the data from @a string.
*/ */

View File

@@ -745,12 +745,6 @@ public:
*/ */
wxAccessible* GetAccessible(); wxAccessible* GetAccessible();
/**
@deprecated
This method is deprecated, use GetEffectiveMinSize() instead.
*/
wxSize GetAdjustedBestSize() const;
/** /**
Returns the background colour of the window. Returns the background colour of the window.

View File

@@ -54,7 +54,7 @@ public:
*/ */
wxXmlResource(const wxString& filemask, wxXmlResource(const wxString& filemask,
int flags = wxXRC_USE_LOCALE, int flags = wxXRC_USE_LOCALE,
const wxString domain = wxEmptyString); const wxString& domain = wxEmptyString);
/** /**
Constructor. Constructor.
@@ -67,7 +67,7 @@ public:
This provides a way to allow the strings to only come from a specific catalog. This provides a way to allow the strings to only come from a specific catalog.
*/ */
wxXmlResource(int flags = wxXRC_USE_LOCALE, wxXmlResource(int flags = wxXRC_USE_LOCALE,
const wxString domain = wxEmptyString); const wxString& domain = wxEmptyString);
/** /**
Destructor. Destructor.