From: Francesco Montorsi Date: Mon, 10 Mar 2008 16:23:56 +0000 (+0000) Subject: interface headers reviewed X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f59be7c6bc01df23729c7d477b6843f931623344 interface headers reviewed git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52429 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc index 0f80a2e9ac..217f499902 100644 --- a/docs/doxygen/Doxyfile.inc +++ b/docs/doxygen/Doxyfile.inc @@ -47,17 +47,17 @@ SUBGROUPING = YES # us to keep the headers readable and "implement" wxWidgets-specific commands. # event aliases -ALIASES = beginEventTable="
Events:" +ALIASES = beginEventTable="\nEvents:" ALIASES += event{1}="\li \1" ALIASES += event{2}="\li \1, \2" ALIASES += event{3}="\li \1, \2, \3" ALIASES += event{4}="\li \1, \2, \3, \4" -ALIASES += endEventTable="
" +ALIASES += endEventTable="\n" # style aliases -ALIASES += beginStyleTable="
Styles:" +ALIASES += beginStyleTable="\nStyles:" ALIASES += style{1}="\li \1" -ALIASES += endStyleTable="
" +ALIASES += endStyleTable="\n" # extra style aliases ALIASES += beginExtraStyleTable="
Extra styles:" @@ -70,10 +70,10 @@ ALIASES += nolibrary="
Library:  Predefined objects:" # native implementation infos: -ALIASES += nativeimpl{1}="
Implementations:  native implementations are used for \ref page_port_\1 port; generic implementation is used elsewhere.
" -ALIASES += nativeimpl{2}="
Implementations:  native implementations are used for \ref page_port_\1, \ref page_port_\2 ports; generic implementation is used elsewhere.
" -ALIASES += nativeimpl{3}="
Implementations:  native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; generic implementation is used elsewhere.
" -ALIASES += nativeimpl{4}="
Implementations:  native implementations are used for \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; generic implementation is used elsewhere.
" +ALIASES += nativeimpl{1}="
Implementations:  native under \ref page_port_\1 port; a generic implementation is used elsewhere.
" +ALIASES += nativeimpl{2}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.
" +ALIASES += nativeimpl{3}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.
" +ALIASES += nativeimpl{4}="
Implementations:  native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.
" # onlyfor infos: ALIASES += onlyfor{1}="
Availability:  only available for the \ref page_port_\1 port.
" diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index 8cf4025f14..cf88943999 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -286,6 +286,7 @@ @li wxPenList: The list of previously-created pens @li wxPalette: Represents a table of indices into RGB values @li wxRegion: Represents a simple or complex region on a window or device context + @li wxAnimation: Represents an animation @li wxRendererNative: Abstracts high-level drawing primitives diff --git a/interface/access.h b/interface/access.h index 941764016a..479a3b9247 100644 --- a/interface/access.h +++ b/interface/access.h @@ -6,30 +6,240 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// + +/** + wxAccessible functions return a wxAccStatus error code, + which may be one of this enum's values. +*/ +typedef enum +{ + wxACC_FAIL, //!< The function failed. + wxACC_FALSE, //!< The function returned false. + wxACC_OK, //!< The function completed successfully. + wxACC_NOT_IMPLEMENTED, //!< The function is not implemented. + wxACC_NOT_SUPPORTED //!< The function is not supported. +} wxAccStatus; + + +/** + Directions of navigation are represented by this enum. +*/ +typedef enum +{ + wxNAVDIR_DOWN, + wxNAVDIR_FIRSTCHILD, + wxNAVDIR_LASTCHILD, + wxNAVDIR_LEFT, + wxNAVDIR_NEXT, + wxNAVDIR_PREVIOUS, + wxNAVDIR_RIGHT, + wxNAVDIR_UP +} wxNavDir; + + +/** + The role of a user interface element is represented by the values of this enum. +*/ +typedef enum { + wxROLE_NONE, + wxROLE_SYSTEM_ALERT, + wxROLE_SYSTEM_ANIMATION, + wxROLE_SYSTEM_APPLICATION, + wxROLE_SYSTEM_BORDER, + wxROLE_SYSTEM_BUTTONDROPDOWN, + wxROLE_SYSTEM_BUTTONDROPDOWNGRID, + wxROLE_SYSTEM_BUTTONMENU, + wxROLE_SYSTEM_CARET, + wxROLE_SYSTEM_CELL, + wxROLE_SYSTEM_CHARACTER, + wxROLE_SYSTEM_CHART, + wxROLE_SYSTEM_CHECKBUTTON, + wxROLE_SYSTEM_CLIENT, + wxROLE_SYSTEM_CLOCK, + wxROLE_SYSTEM_COLUMN, + wxROLE_SYSTEM_COLUMNHEADER, + wxROLE_SYSTEM_COMBOBOX, + wxROLE_SYSTEM_CURSOR, + wxROLE_SYSTEM_DIAGRAM, + wxROLE_SYSTEM_DIAL, + wxROLE_SYSTEM_DIALOG, + wxROLE_SYSTEM_DOCUMENT, + wxROLE_SYSTEM_DROPLIST, + wxROLE_SYSTEM_EQUATION, + wxROLE_SYSTEM_GRAPHIC, + wxROLE_SYSTEM_GRIP, + wxROLE_SYSTEM_GROUPING, + wxROLE_SYSTEM_HELPBALLOON, + wxROLE_SYSTEM_HOTKEYFIELD, + wxROLE_SYSTEM_INDICATOR, + wxROLE_SYSTEM_LINK, + wxROLE_SYSTEM_LIST, + wxROLE_SYSTEM_LISTITEM, + wxROLE_SYSTEM_MENUBAR, + wxROLE_SYSTEM_MENUITEM, + wxROLE_SYSTEM_MENUPOPUP, + wxROLE_SYSTEM_OUTLINE, + wxROLE_SYSTEM_OUTLINEITEM, + wxROLE_SYSTEM_PAGETAB, + wxROLE_SYSTEM_PAGETABLIST, + wxROLE_SYSTEM_PANE, + wxROLE_SYSTEM_PROGRESSBAR, + wxROLE_SYSTEM_PROPERTYPAGE, + wxROLE_SYSTEM_PUSHBUTTON, + wxROLE_SYSTEM_RADIOBUTTON, + wxROLE_SYSTEM_ROW, + wxROLE_SYSTEM_ROWHEADER, + wxROLE_SYSTEM_SCROLLBAR, + wxROLE_SYSTEM_SEPARATOR, + wxROLE_SYSTEM_SLIDER, + wxROLE_SYSTEM_SOUND, + wxROLE_SYSTEM_SPINBUTTON, + wxROLE_SYSTEM_STATICTEXT, + wxROLE_SYSTEM_STATUSBAR, + wxROLE_SYSTEM_TABLE, + wxROLE_SYSTEM_TEXT, + wxROLE_SYSTEM_TITLEBAR, + wxROLE_SYSTEM_TOOLBAR, + wxROLE_SYSTEM_TOOLTIP, + wxROLE_SYSTEM_WHITESPACE, + wxROLE_SYSTEM_WINDOW +} wxAccRole; + +/** + Objects are represented by a wxAccObject enum value. +*/ +typedef enum { + wxOBJID_WINDOW = 0x00000000, + wxOBJID_SYSMENU = 0xFFFFFFFF, + wxOBJID_TITLEBAR = 0xFFFFFFFE, + wxOBJID_MENU = 0xFFFFFFFD, + wxOBJID_CLIENT = 0xFFFFFFFC, + wxOBJID_VSCROLL = 0xFFFFFFFB, + wxOBJID_HSCROLL = 0xFFFFFFFA, + wxOBJID_SIZEGRIP = 0xFFFFFFF9, + wxOBJID_CARET = 0xFFFFFFF8, + wxOBJID_CURSOR = 0xFFFFFFF7, + wxOBJID_ALERT = 0xFFFFFFF6, + wxOBJID_SOUND = 0xFFFFFFF5 +} wxAccObject; + + +/** + Selection actions are identified by the wxAccSelectionFlags values. +*/ +typedef enum +{ + wxACC_SEL_NONE = 0, + wxACC_SEL_TAKEFOCUS = 1, + wxACC_SEL_TAKESELECTION = 2, + wxACC_SEL_EXTENDSELECTION = 4, + wxACC_SEL_ADDSELECTION = 8, + wxACC_SEL_REMOVESELECTION = 16 +} wxAccSelectionFlags; + +//@{ +/** + Represents a status of the system. +*/ +#define wxACC_STATE_SYSTEM_ALERT_HIGH 0x00000001 +#define wxACC_STATE_SYSTEM_ALERT_MEDIUM 0x00000002 +#define wxACC_STATE_SYSTEM_ALERT_LOW 0x00000004 +#define wxACC_STATE_SYSTEM_ANIMATED 0x00000008 +#define wxACC_STATE_SYSTEM_BUSY 0x00000010 +#define wxACC_STATE_SYSTEM_CHECKED 0x00000020 +#define wxACC_STATE_SYSTEM_COLLAPSED 0x00000040 +#define wxACC_STATE_SYSTEM_DEFAULT 0x00000080 +#define wxACC_STATE_SYSTEM_EXPANDED 0x00000100 +#define wxACC_STATE_SYSTEM_EXTSELECTABLE 0x00000200 +#define wxACC_STATE_SYSTEM_FLOATING 0x00000400 +#define wxACC_STATE_SYSTEM_FOCUSABLE 0x00000800 +#define wxACC_STATE_SYSTEM_FOCUSED 0x00001000 +#define wxACC_STATE_SYSTEM_HOTTRACKED 0x00002000 +#define wxACC_STATE_SYSTEM_INVISIBLE 0x00004000 +#define wxACC_STATE_SYSTEM_MARQUEED 0x00008000 +#define wxACC_STATE_SYSTEM_MIXED 0x00010000 +#define wxACC_STATE_SYSTEM_MULTISELECTABLE 0x00020000 +#define wxACC_STATE_SYSTEM_OFFSCREEN 0x00040000 +#define wxACC_STATE_SYSTEM_PRESSED 0x00080000 +#define wxACC_STATE_SYSTEM_PROTECTED 0x00100000 +#define wxACC_STATE_SYSTEM_READONLY 0x00200000 +#define wxACC_STATE_SYSTEM_SELECTABLE 0x00400000 +#define wxACC_STATE_SYSTEM_SELECTED 0x00800000 +#define wxACC_STATE_SYSTEM_SELFVOICING 0x01000000 +#define wxACC_STATE_SYSTEM_UNAVAILABLE 0x02000000 +//@} + +//@{ +/** + An event identifier that can be sent via wxAccessible::NotifyEvent. +*/ +#define wxACC_EVENT_SYSTEM_SOUND 0x0001 +#define wxACC_EVENT_SYSTEM_ALERT 0x0002 +#define wxACC_EVENT_SYSTEM_FOREGROUND 0x0003 +#define wxACC_EVENT_SYSTEM_MENUSTART 0x0004 +#define wxACC_EVENT_SYSTEM_MENUEND 0x0005 +#define wxACC_EVENT_SYSTEM_MENUPOPUPSTART 0x0006 +#define wxACC_EVENT_SYSTEM_MENUPOPUPEND 0x0007 +#define wxACC_EVENT_SYSTEM_CAPTURESTART 0x0008 +#define wxACC_EVENT_SYSTEM_CAPTUREEND 0x0009 +#define wxACC_EVENT_SYSTEM_MOVESIZESTART 0x000A +#define wxACC_EVENT_SYSTEM_MOVESIZEEND 0x000B +#define wxACC_EVENT_SYSTEM_CONTEXTHELPSTART 0x000C +#define wxACC_EVENT_SYSTEM_CONTEXTHELPEND 0x000D +#define wxACC_EVENT_SYSTEM_DRAGDROPSTART 0x000E +#define wxACC_EVENT_SYSTEM_DRAGDROPEND 0x000F +#define wxACC_EVENT_SYSTEM_DIALOGSTART 0x0010 +#define wxACC_EVENT_SYSTEM_DIALOGEND 0x0011 +#define wxACC_EVENT_SYSTEM_SCROLLINGSTART 0x0012 +#define wxACC_EVENT_SYSTEM_SCROLLINGEND 0x0013 +#define wxACC_EVENT_SYSTEM_SWITCHSTART 0x0014 +#define wxACC_EVENT_SYSTEM_SWITCHEND 0x0015 +#define wxACC_EVENT_SYSTEM_MINIMIZESTART 0x0016 +#define wxACC_EVENT_SYSTEM_MINIMIZEEND 0x0017 +#define wxACC_EVENT_OBJECT_CREATE 0x8000 +#define wxACC_EVENT_OBJECT_DESTROY 0x8001 +#define wxACC_EVENT_OBJECT_SHOW 0x8002 +#define wxACC_EVENT_OBJECT_HIDE 0x8003 +#define wxACC_EVENT_OBJECT_REORDER 0x8004 +#define wxACC_EVENT_OBJECT_FOCUS 0x8005 +#define wxACC_EVENT_OBJECT_SELECTION 0x8006 +#define wxACC_EVENT_OBJECT_SELECTIONADD 0x8007 +#define wxACC_EVENT_OBJECT_SELECTIONREMOVE 0x8008 +#define wxACC_EVENT_OBJECT_SELECTIONWITHIN 0x8009 +#define wxACC_EVENT_OBJECT_STATECHANGE 0x800A +#define wxACC_EVENT_OBJECT_LOCATIONCHANGE 0x800B +#define wxACC_EVENT_OBJECT_NAMECHANGE 0x800C +#define wxACC_EVENT_OBJECT_DESCRIPTIONCHANGE 0x800D +#define wxACC_EVENT_OBJECT_VALUECHANGE 0x800E +#define wxACC_EVENT_OBJECT_PARENTCHANGE 0x800F +#define wxACC_EVENT_OBJECT_HELPCHANGE 0x8010 +#define wxACC_EVENT_OBJECT_DEFACTIONCHANGE 0x8011 +#define wxACC_EVENT_OBJECT_ACCELERATORCHANGE 0x8012 +//@} + /** @class wxAccessible @wxheader{access.h} - The wxAccessible class allows wxWidgets applications, and - wxWidgets itself, to return extended information about user interface elements - to client applications such as screen readers. This is the - main way in which wxWidgets implements accessibility features. + The wxAccessible class allows wxWidgets applications, and wxWidgets itself, + to return extended information about user interface elements to client + applications such as screen readers. This is the main way in which wxWidgets + implements accessibility features. - At present, only Microsoft Active Accessibility is supported - by this class. + At present, only Microsoft Active Accessibility is supported by this class. To use this class, derive from wxAccessible, implement appropriate - functions, and associate an object of the class with a - window using wxWindow::SetAccessible. + functions, and associate an object of the class with a window using + wxWindow::SetAccessible. All functions return an indication of success, failure, or not implemented using values of the wxAccStatus enum type. - If you return wxACC_NOT_IMPLEMENTED from any function, the system will try to - implement the appropriate functionality. However this will not work with + If you return @c wxACC_NOT_IMPLEMENTED from any function, the system will try + to implement the appropriate functionality. However this will not work with all functions. - Most functions work with an @e object id, which can be zero to refer to + Most functions work with an object @e id, which can be zero to refer to 'this' UI element, or greater than zero to refer to the nth child element. This allows you to specify elements that don't have a corresponding wxWindow or wxAccessible; for example, the sash of a splitter window. @@ -40,8 +250,10 @@ This class is compiled into wxWidgets only if the wxUSE_ACCESSIBILITY setup symbol is set to 1. + @onlyfor{wxmsw} + @library{wxcore} - @category{FIXME} + @category{misc} */ class wxAccessible : public wxObject { @@ -58,17 +270,20 @@ public: ~wxAccessible(); /** - Performs the default action for the object. @a childId is 0 (the action for - this object) - or greater than 0 (the action for a child). Return wxACC_NOT_SUPPORTED if there - is no default action for this window (e.g. an edit control). + Performs the default action for the object. + @a childId is 0 (the action for this object) or greater than 0 (the action + for a child). + + @returns + wxACC_NOT_SUPPORTED if there is no default action for this window + (e.g. an edit control). */ virtual wxAccStatus DoDefaultAction(int childId); /** Gets the specified child (starting from 1). If @a child is @NULL and the return - value is wxACC_OK, - this means that the child is a simple element and not an accessible object. + value is wxACC_OK, this means that the child is a simple element and not an + accessible object. */ virtual wxAccStatus GetChild(int childId, wxAccessible** child); @@ -79,13 +294,12 @@ public: /** Gets the default action for this object (0) or a child (greater than 0). + Return wxACC_OK even if there is no action. @a actionName is the action, or the - empty - string if there is no action. The retrieved string describes the action that is - performed on an object, - not what the object does as a result. For example, a toolbar button that prints - a document has a default action of "Press" rather than "Prints the current - document." + empty string if there is no action. The retrieved string describes the action that is + performed on an object, not what the object does as a result. For example, a toolbar + button that prints a document has a default action of "Press" rather than "Prints + the current document." */ virtual wxAccStatus GetDefaultAction(int childId, wxString* actionName); @@ -98,9 +312,8 @@ public: /** Gets the window with the keyboard focus. If childId is 0 and child is @NULL, no - object in - this subhierarchy has the focus. If this object has the focus, child should be - 'this'. + object in this subhierarchy has the focus. If this object has the focus, child + should be 'this'. */ virtual wxAccStatus GetFocus(int* childId, wxAccessible** child); @@ -111,7 +324,7 @@ public: /** Returns the keyboard shortcut for this object or child. - Return e.g. ALT+K. + Returns e.g. ALT+K. */ virtual wxAccStatus GetKeyboardShortcut(int childId, wxString* shortcut); @@ -134,26 +347,25 @@ public: virtual wxAccStatus GetParent(wxAccessible** parent); /** - Returns a role constant describing this object. See wxAccessible for a list + Returns a role constant describing this object. See wxAccRole for a list of these roles. */ virtual wxAccStatus GetRole(int childId, wxAccRole* role); /** - Gets a variant representing the selected children - of this object. + Gets a variant representing the selected children of this object. + Acceptable values are: - a null variant (IsNull() returns TRUE) - a list variant (GetType() == wxT("list")) - an integer representing the selected child element, - or 0 if this object is selected (GetType() == wxT("long")) - a "void*" pointer to a wxAccessible child object + @li a null variant (IsNull() returns @true) + @li a list variant (GetType() == wxT("list")) + @li an integer representing the selected child element, + or 0 if this object is selected (GetType() == wxT("long")) + @li a "void*" pointer to a wxAccessible child object */ virtual wxAccStatus GetSelections(wxVariant* selections); /** - Returns a state constant. See wxAccessible for a list - of these states. + Returns a state constant. See wxAccStatus for a list of these states. */ virtual wxAccStatus GetState(int childId, long* state); @@ -169,32 +381,32 @@ public: wxWindow* GetWindow(); /** - Returns a status value and object id to indicate whether the given point was on - this or - a child object. Can return either a child object, or an integer - representing the child element, starting from 1. + Returns a status value and object id to indicate whether the given point + was on this or a child object. Can return either a child object, or an + integer representing the child element, starting from 1. + @a pt is in screen coordinates. */ virtual wxAccStatus HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject); /** - Navigates from @a fromId to @e toId/@e toObject. + Navigates from @a fromId to @e toId or to @e toObject. */ virtual wxAccStatus Navigate(wxNavDir navDir, int fromId, int* toId, wxAccessible** toObject); /** - Allows the application to send an event when something changes in an accessible - object. + Allows the application to send an event when something changes in + an accessible object. */ virtual static void NotifyEvent(int eventType, wxWindow* window, wxAccObject objectType, int objectType); /** - Selects the object or child. See wxAccessible for a list + Selects the object or child. See wxAccSelectionFlags for a list of the selection actions. */ virtual wxAccStatus Select(int childId, diff --git a/interface/animate.h b/interface/animate.h index 5ce14baba6..2b66e92db9 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -1,18 +1,35 @@ ///////////////////////////////////////////////////////////////////////////// // Name: animate.h -// Purpose: interface of wxAnimationCtrl +// Purpose: interface of wxAnimation* classes // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +/** + Supported animation types. +*/ +enum wxAnimationType +{ + wxANIMATION_TYPE_INVALID, + + /** represents an animated GIF file. */ + wxANIMATION_TYPE_GIF, + + /** represents an ANI file. */ + wxANIMATION_TYPE_ANI, + + /** autodetect the filetype. */ + wxANIMATION_TYPE_ANY +}; + /** @class wxAnimationCtrl @wxheader{animate.h} This is a static control which displays an animation. - wxAnimationCtrl API is simple as possible and won't give you full control on the - animation; if you need it then use wxMediaCtrl. + wxAnimationCtrl API is as simple as possible and won't give you full control + on the animation; if you need it then use wxMediaCtrl. This control is useful to display a (small) animation while doing a long task (e.g. a "throbber"). @@ -30,6 +47,9 @@ @library{wxadv} @category{ctrl} + + @nativeimpl{wxgtk,wxmsw} + @appearance{animationctrl.png} @see wxAnimation @@ -49,9 +69,10 @@ public: const wxString& name = "animationctrl"); /** - After control creation you must explicitely call Play() - to start to play the animation. Until that function won't be called, the first - frame + Creates the control with the given @a anim animation. + + After control creation you must explicitely call Play() to start to play + the animation. Until that function won't be called, the first frame of the animation is displayed. @param parent @@ -104,46 +125,43 @@ public: /** Starts playing the animation. + The animation is always played in loop mode (unless the last frame of the - animation - has an infinite delay time) and always start from the first frame - (even if you @ref stop() stopped it while some other frame was - displayed). + animation has an infinite delay time) and always start from the first frame + even if you @ref Stop "stopped" it while some other frame was displayed. */ bool Play(); /** Sets the animation to play in this control. - If the previous animation is being played, it's @ref stop() Stopped. - Until Play() isn't called, a static image, the first - frame of the given animation or the background colour will be shown + + If the previous animation is being played, it's @ref Stop() stopped. + Until Play() isn't called, a static image, the first frame of the given + animation or the background colour will be shown (see SetInactiveBitmap() for more info). */ void SetAnimation(const wxAnimation& anim); /** Sets the bitmap to show on the control when it's not playing an animation. - If you set as inactive bitmap @c wxNullBitmap (which is the default), then the - first frame of the animation is instead shown when the control is inactive; in - this case, - if there's no valid animation associated with the control (see - wxAnimationCtrl::SetAnimation), - then the background colour of the window is shown. + + If you set as inactive bitmap ::wxNullBitmap (which is the default), then the + first frame of the animation is instead shown when the control is inactive; + in this case, if there's no valid animation associated with the control + (see SetAnimation()), then the background colour of the window is shown. + If the control is not playing the animation, the given bitmap will be - immediately - shown, otherwise it will be shown as soon as Stop() - is called. + immediately shown, otherwise it will be shown as soon as Stop() is called. + Note that the inactive bitmap, if smaller than the control's size, will be - centered in - the control; if bigger, it will be stretched to fit it. + centered in the control; if bigger, it will be stretched to fit it. */ void SetInactiveBitmap(const wxBitmap& bmp); /** Stops playing the animation. The control will show the first frame of the animation, a custom static image or - the window's background colour as specified by the - last SetInactiveBitmap() call. + the window's background colour as specified by the last SetInactiveBitmap() call. */ void Stop(); }; @@ -159,17 +177,19 @@ public: Sound is not supported by wxAnimation. @library{wxadv} - @category{FIXME} + @category{gdi} @stdobjects - ::Objects:, ::wxNullAnimation, + ::wxNullAnimation @see wxAnimationCtrl */ class wxAnimation : public wxGDIObject { public: - //@{ + wxAnimation(); + wxAnimation(const wxAnimation& anim); + /** Loads an animation from a file. @@ -178,16 +198,12 @@ public: @param type See LoadFile for more info. */ - wxAnimation(); - wxAnimation(const wxAnimation& anim); wxAnimation(const wxString& name, wxAnimationType type = wxANIMATION_TYPE_ANY); - //@} /** Destructor. - See @ref overview_refcountdestruct "reference-counted object destruction" for - more info. + See @ref overview_refcount_destruct for more info. */ ~wxAnimation(); @@ -224,41 +240,9 @@ public: The stream to use to load the animation. @param type One of the following values: - - - - - - - - wxANIMATION_TYPE_GIF - - - - - Load an animated GIF file. - - - - - - wxANIMATION_TYPE_ANI - - - - - Load an ANI file. - - - - - - wxANIMATION_TYPE_ANY - - - - - Try to autodetect the filetype. + @li wxANIMATION_TYPE_GIF: loads an animated GIF file; + @li wxANIMATION_TYPE_ANI: load an ANI file; + @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype. @returns @true if the operation succeeded, @false otherwise. */ @@ -271,42 +255,8 @@ public: @param name A filename. @param type - One of the following values: - - - - - - - - wxANIMATION_TYPE_GIF - - - - - Load an animated GIF file. - - - - - - wxANIMATION_TYPE_ANI - - - - - Load an ANI file. - - - - - - wxANIMATION_TYPE_ANY - - - - - Try to autodetect the filetype. + One of the wxAnimationType values; wxANIMATION_TYPE_ANY + means that the function should try to autodetect the filetype. @returns @true if the operation succeeded, @false otherwise. */ @@ -314,21 +264,13 @@ public: wxAnimationType type = wxANIMATION_TYPE_ANY); /** - Assignment operator, using @ref overview_trefcount "reference counting". + Assignment operator, using @ref overview_refcount "reference counting". */ wxAnimation operator =(const wxAnimation& brush); }; - /** - FIXME -*/ -wxAnimation Objects: -; - -/** - FIXME + An empty animation object. */ wxAnimation wxNullAnimation; -