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

fix the signature of the documented functions and document some (relatively) new for wxAcceleratorEntry

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52639 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-03-20 22:32:46 +00:00
parent 25af884d93
commit 3d8662ab0f
2 changed files with 54 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
interface/accel.h
View File

@ -42,11 +42,6 @@ enum wxAcceleratorEntryFlags
class wxAcceleratorEntry
{
public:
/**
Default ctor.
*/
wxAcceleratorEntry();
/**
Constructor.
@ -56,9 +51,17 @@ public:
@param keyCode
The keycode to be detected. See @ref page_keycodes for a full list of keycodes.
@param cmd
The menu or control command identifier.
The menu or control command identifier (ID).
@param item
The menu item associated with this accelerator.
*/
wxAcceleratorEntry(int flags, int keyCode, int cmd);
wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0,
wxMenuItem *item = NULL);
/**
Copy ctor.
*/
wxAcceleratorEntry(const wxAcceleratorEntry& entry);
/**
Returns the command identifier for the accelerator table entry.
@ -75,6 +78,11 @@ public:
*/
int GetKeyCode() const;
/**
Returns the menu item associated with this accelerator entry.
*/
wxMenuItem *GetMenuItem() const;
/**
Sets the accelerator entry parameters.
@ -84,10 +92,39 @@ public:
@param keyCode
The keycode to be detected. See @ref page_keycodes for a full list of keycodes.
@param cmd
The menu or control command identifier.
The menu or control command identifier (ID).
@param item
The menu item associated with this accelerator.
*/
void Set(int flags, int keyCode, int cmd);
void Set(int flags, int keyCode, int cmd, wxMenuItem *item = NULL);
/**
Returns @true if this object is correctly initialized.
*/
bool IsOk() const;
/**
Returns a wxString for this accelerator.
This function formats it using the @c "flags-keycode" format
where @c flags maybe a hyphen-separed list of @c "shift|alt|ctrl".
*/
wxString ToString() const;
/**
Parses the given string and sets the accelerator accordingly.
@param str
Should be a string in the form "flags-keycode"
@returns @true if the given string correctly initialized this object
(i.e. if IsOk() returns true after this call)
*/
bool FromString(const wxString& str);
wxAcceleratorEntry& operator=(const wxAcceleratorEntry& entry);
bool operator==(const wxAcceleratorEntry& entry) const;
bool operator!=(const wxAcceleratorEntry& entry) const;
};
@ -144,7 +181,7 @@ public:
@param entries
The array of entries.
*/
wxAcceleratorTable(int n, wxAcceleratorEntry entries[]);
wxAcceleratorTable(int n, const wxAcceleratorEntry entries[]);
/**
Loads the accelerator table from a Windows resource (Windows only).
@ -164,14 +201,6 @@ public:
Returns @true if the accelerator table is valid.
*/
bool IsOk() const;
/**
Assignment operator, using @ref overview_refcount "reference counting".
@param accel
Accelerator table to assign.
*/
wxAcceleratorTable operator =(const wxAcceleratorTable& accel);
};

10
interface/animate.h
View File

@ -62,7 +62,7 @@ public:
all the parameters.
*/
wxAnimationCtrl(wxWindow* parent, wxWindowID id,
const wxAnimation& anim,
const wxAnimation& anim = wxNullAnimation,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxAC_DEFAULT_STYLE,
@ -94,7 +94,7 @@ public:
creation failed.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxAnimation& anim,
const wxAnimation& anim = wxNullAnimation,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxAC_DEFAULT_STYLE,
@ -187,7 +187,9 @@ public:
class wxAnimation : public wxGDIObject
{
public:
wxAnimation();
/**
Copy ctor.
*/
wxAnimation(const wxAnimation& anim);
/**
@ -266,7 +268,7 @@ public:
/**
Assignment operator, using @ref overview_refcount "reference counting".
*/
wxAnimation operator =(const wxAnimation& brush);
wxAnimation& operator =(const wxAnimation& brush);
};