git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52753
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
Destroys the wxAcceleratorTable object.
See @ref overview_refcount_destruct for more info.
*/
Destroys the wxAcceleratorTable object.
See @ref overview_refcount_destruct for more info.
*/
+ virtual ~wxAcceleratorTable();
/**
Returns @true if the accelerator table is valid.
/**
Returns @true if the accelerator table is valid.
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxAC_DEFAULT_STYLE,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxAC_DEFAULT_STYLE,
- const wxString& name = "animationctrl");
+ const wxString& name = wxAnimationCtrlNameStr);
/**
Returns the animation associated with this control.
/**
Returns the animation associated with this control.
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.
*/
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.
*/
- void SetInactiveBitmap(const wxBitmap& bmp);
+ virtual void SetInactiveBitmap(const wxBitmap& bmp);
/**
Stops playing the animation.
/**
Stops playing the animation.
Destructor.
See @ref overview_refcount_destruct for more info.
*/
Destructor.
See @ref overview_refcount_destruct for more info.
*/
+ virtual ~wxAnimation();
/**
Returns the delay for the i-th frame in milliseconds.
/**
Returns the delay for the i-th frame in milliseconds.
the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will
be @NULL if just wxASSERT or wxFAIL was used
*/
the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will
be @NULL if just wxASSERT or wxFAIL was used
*/
- virtual void OnAssertFailure(const wxChar file, int line,
- const wxChar func,
- const wxChar cond,
- const wxChar msg);
+ virtual void OnAssertFailure(const wxChar *file,
+ int line,
+ const wxChar *func,
+ const wxChar *cond,
+ const wxChar *msg);
/**
Called when command line parsing fails (i.e. an incorrect command line option
/**
Called when command line parsing fails (i.e. an incorrect command line option
If this function returns @false and you need to attract users attention to
the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
*/
If this function returns @false and you need to attract users attention to
the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
*/
+ virtual bool IsActive() const;
/**
Windows-only function for processing a message. This function is called
/**
Windows-only function for processing a message. This function is called
- bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
+ virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
/**
Allows the programmer to specify whether the application will exit when the
/**
Allows the programmer to specify whether the application will exit when the
Returns the wxStandardPaths object for the application.
It's normally the same for wxBase and wxGUI except in the case of wxMac
and wxCocoa.
Returns the wxStandardPaths object for the application.
It's normally the same for wxBase and wxGUI except in the case of wxMac
and wxCocoa.
+
+ @todo the real function returns a reference to wxStandardPathsBase;
+ user looking at these docs will write code:
+ wxStandardPaths &ref = ...->GetStandardPaths();
+ which won't compile...
*/
virtual wxStandardPaths& GetStandardPaths();
*/
virtual wxStandardPaths& GetStandardPaths();
and put in given pointers the versions of the GTK library in use.
See wxPlatformInfo for more details.
*/
and put in given pointers the versions of the GTK library in use.
See wxPlatformInfo for more details.
*/
- virtual wxPortId GetToolkitVersion(int* major = NULL,
- int* minor = NULL);
+ virtual wxPortId GetToolkitVersion(int* major = NULL, int* minor = NULL) const;
/**
Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise.
/**
Returns @true if @c fprintf(stderr) goes somewhere, @false otherwise.
Returns @true if the library was built as wxUniversal.
Always returns @false for wxBase-only apps.
*/
Returns @true if the library was built as wxUniversal.
Always returns @false for wxBase-only apps.
*/
- bool IsUsingUniversalWidgets() const;
+ virtual bool IsUsingUniversalWidgets() const;
/**
Shows the assert dialog with the specified message in GUI mode or just prints
/**
Shows the assert dialog with the specified message in GUI mode or just prints
Closes the current entry. On a non-seekable stream reads to the end of
the current entry first.
*/
Closes the current entry. On a non-seekable stream reads to the end of
the current entry first.
*/
+ virtual bool CloseEntry();
/**
Closes the current entry if one is open, then reads the meta-data for
/**
Closes the current entry if one is open, then reads the meta-data for
@a entry must be from the same archive file that this wxArchiveInputStream
is reading, and it must be reading it from a seekable stream.
*/
@a entry must be from the same archive file that this wxArchiveInputStream
is reading, and it must be reading it from a seekable stream.
*/
- bool OpenEntry(wxArchiveEntry& entry);
+ virtual bool OpenEntry(wxArchiveEntry& entry);
/**
Calls Close() if it has not already been called.
*/
/**
Calls Close() if it has not already been called.
*/
- ~wxArchiveOutputStream();
+ virtual ~wxArchiveOutputStream();
/**
Closes the archive, returning @true if it was successfully written.
/**
Closes the archive, returning @true if it was successfully written.
This function uses linear search for wxArrayString.
Returns index of the first item matched or @c wxNOT_FOUND if there is no match.
*/
This function uses linear search for wxArrayString.
Returns index of the first item matched or @c wxNOT_FOUND if there is no match.
*/
- int Index(const wxString& sz, bool bCase = true,
- bool bFromEnd = false);
+ int Index(const wxString& sz, bool bCase = true, bool bFromEnd = false) const;
/**
Insert the given number of @a copies of the new element in the array before the
/**
Insert the given number of @a copies of the new element in the array before the
Returns @true if the array is empty, @false otherwise. This function returns the
same result as @e GetCount() == 0 but is probably easier to read.
*/
Returns @true if the array is empty, @false otherwise. This function returns the
same result as @e GetCount() == 0 but is probably easier to read.
*/
- Return the array element at position @e nIndex. An assert failure will
+ Return the array element at position @a nIndex. An assert failure will
result from an attempt to access an element beyond the end of array in debug
mode, but no check is done in release mode.
@see operator[] for the operator version.
*/
result from an attempt to access an element beyond the end of array in debug
mode, but no check is done in release mode.
@see operator[] for the operator version.
*/
- wxString Item(size_t nIndex) const;
+ wxString& Item(size_t nIndex) const;
/**
Returns the last element of the array. Attempt to access the last element of
an empty array will result in assert failure in debug build, however no checks
are done in release mode.
*/
/**
Returns the last element of the array. Attempt to access the last element of
an empty array will result in assert failure in debug build, however no checks
are done in release mode.
*/
+ wxString& Last() const;
/**
Removes the first item matching this value. An assert failure is provoked by
/**
Removes the first item matching this value. An assert failure is provoked by
/**
Assignment operator.
*/
/**
Assignment operator.
*/
- wxArrayString operator =(const wxArrayString& array);
+ wxArrayString& operator=(const wxArrayString&);
/**
Compares 2 arrays respecting the case. Returns @true only if the arrays have
/**
Compares 2 arrays respecting the case. Returns @true only if the arrays have
bool operator ==(const wxArrayString& array) const;
/**
bool operator ==(const wxArrayString& array) const;
/**
- Return the array element at position @e nIndex. An assert failure will
+ Return the array element at position @a nIndex. An assert failure will
result from an attempt to access an element beyond the end of array in
debug mode, but no check is done in release mode.
This is the operator version of the Item() method.
*/
result from an attempt to access an element beyond the end of array in
debug mode, but no check is done in release mode.
This is the operator version of the Item() method.
*/
- wxString operator[](size_t nIndex);
+ wxString& operator[](size_t nIndex) const;
The destructor automatically removes the provider from the provider stack used
by GetBitmap().
*/
The destructor automatically removes the provider from the provider stack used
by GetBitmap().
*/
+ virtual ~wxArtProvider();
/**
Derived art provider classes must override this method to create requested art
/**
Derived art provider classes must override this method to create requested art
@section wxauimanager_layers Layers, Rows and Directions, Positions
@section wxauimanager_layers Layers, Rows and Directions, Positions
- Inside wxAUI, the docking layout is figured out by checking several pane
+ Inside wxAUI, the docking layout is figured out by checking several pane
parameters. Four of these are important for determining where a pane will end up:
@li Direction: Each docked pane has a direction, Top, Bottom, Left, Right, or Center.
parameters. Four of these are important for determining where a pane will end up:
@li Direction: Each docked pane has a direction, Top, Bottom, Left, Right, or Center.
being docked on the left side of a window. One pane can be placed over another.
In proportionally managed docks, the pane position indicates its sequential position,
starting with zero. So, in our scenario with two panes docked on the left side,
being docked on the left side of a window. One pane can be placed over another.
In proportionally managed docks, the pane position indicates its sequential position,
starting with zero. So, in our scenario with two panes docked on the left side,
- the top pane in the dock would have position 0, and the second one would occupy
+ the top pane in the dock would have position 0, and the second one would occupy
- @li Row: A row can allow for two docks to be placed next to each other. One of the
+ @li Row: A row can allow for two docks to be placed next to each other. One of the
most common places for this to happen is in the toolbar. Multiple toolbar rows
are allowed, the first row being row 0, and the second row 1. Rows can also be
used on vertically docked panes.
most common places for this to happen is in the toolbar. Multiple toolbar rows
are allowed, the first row being row 0, and the second row 1. Rows can also be
used on vertically docked panes.
+ virtual ~wxAuiManager();
/**
Calling this method will return the wxAuiManager for a given window.
/**
Calling this method will return the wxAuiManager for a given window.
- The @a window parameter should specify any child window or sub-child
+ The @a window parameter should specify any child window or sub-child
window of the frame or window managed by wxAuiManager.
The @a window parameter need not be managed by the manager itself, nor does it
window of the frame or window managed by wxAuiManager.
The @a window parameter need not be managed by the manager itself, nor does it
or by pane name, which acts as a unique id for a window pane.
The returned wxAuiPaneInfo object may then be modified to change a pane's
or by pane name, which acts as a unique id for a window pane.
The returned wxAuiPaneInfo object may then be modified to change a pane's
- look, state or position. After one or more modifications to wxAuiPaneInfo,
- wxAuiManager::Update() should be called to commit the changes to the user
- interface. If the lookup failed (meaning the pane could not be found in the
+ look, state or position. After one or more modifications to wxAuiPaneInfo,
+ wxAuiManager::Update() should be called to commit the changes to the user
+ interface. If the lookup failed (meaning the pane could not be found in the
manager), a call to the returned wxAuiPaneInfo's IsOk() method will return @false.
*/
wxAuiPaneInfo GetPane(wxWindow* window);
manager), a call to the returned wxAuiPaneInfo's IsOk() method will return @false.
*/
wxAuiPaneInfo GetPane(wxWindow* window);
/**
Instructs wxAuiManager to use art provider specified by parameter
/**
Instructs wxAuiManager to use art provider specified by parameter
- @a art_provider for all drawing calls.
+ @a art_provider for all drawing calls.
This allows plugable look-and-feel features. The previous art provider object,
if any, will be deleted by wxAuiManager.
This allows plugable look-and-feel features. The previous art provider object,
if any, will be deleted by wxAuiManager.
/**
When a user creates a new dock by dragging a window into a docked position,
often times the large size of the window will create a dock that is unwieldly
/**
When a user creates a new dock by dragging a window into a docked position,
often times the large size of the window will create a dock that is unwieldly
- large. wxAuiManager by default limits the size of any new dock to 1/3 of the
+ large. wxAuiManager by default limits the size of any new dock to 1/3 of the
window size. For horizontal docks, this would be 1/3 of the window height.
For vertical docks, 1/3 of the width.
window size. For horizontal docks, this would be 1/3 of the window height.
For vertical docks, 1/3 of the width.
/**
This function is used by controls to explicitly show a hint window at the
specified rectangle. It is rarely called, and is mostly used by controls
/**
This function is used by controls to explicitly show a hint window at the
specified rectangle. It is rarely called, and is mostly used by controls
- implementing custom pane drag/drop behaviour.
+ implementing custom pane drag/drop behaviour.
The specified rectangle should be in screen coordinates.
*/
void ShowHint(const wxRect& rect);
/**
Uninitializes the framework and should be called before a managed frame or
The specified rectangle should be in screen coordinates.
*/
void ShowHint(const wxRect& rect);
/**
Uninitializes the framework and should be called before a managed frame or
- window is destroyed. UnInit() is usually called in the managed wxFrame's
- destructor. It is necessary to call this function before the managed frame
- or window is destroyed, otherwise the manager cannot remove its custom event
+ window is destroyed. UnInit() is usually called in the managed wxFrame's
+ destructor. It is necessary to call this function before the managed frame
+ or window is destroyed, otherwise the manager cannot remove its custom event
handlers from a window.
*/
void UnInit();
handlers from a window.
*/
void UnInit();
wxAuiPaneInfo specifies all the parameters for a pane.
These parameters specify where the pane is on the screen, whether it is docked
or floating, or hidden.
wxAuiPaneInfo specifies all the parameters for a pane.
These parameters specify where the pane is on the screen, whether it is docked
or floating, or hidden.
- In addition, these parameters specify the pane's docked position, floating
+ In addition, these parameters specify the pane's docked position, floating
position, preferred size, minimum size, caption text among many other parameters.
@library{wxbase}
position, preferred size, minimum size, caption text among many other parameters.
@library{wxbase}
//@{
/**
CentrePane() specifies that the pane should adopt the default center pane
//@{
/**
CentrePane() specifies that the pane should adopt the default center pane
- settings. Centre panes usually do not have caption bars.
+ settings. Centre panes usually do not have caption bars.
This function provides an easy way of preparing a pane to be displayed in
the center dock position.
*/
This function provides an easy way of preparing a pane to be displayed in
the center dock position.
*/
/**
DestroyOnClose() indicates whether a pane should be detroyed when it is closed.
/**
DestroyOnClose() indicates whether a pane should be detroyed when it is closed.
- Normally a pane is simply hidden when the close button is clicked.
+ Normally a pane is simply hidden when the close button is clicked.
Setting DestroyOnClose to @true will cause the window to be destroyed when
the user clicks the pane's close button.
*/
Setting DestroyOnClose to @true will cause the window to be destroyed when
the user clicks the pane's close button.
*/
/**
DockFixed() causes the containing dock to have no resize sash. This is useful
/**
DockFixed() causes the containing dock to have no resize sash. This is useful
- for creating panes that span the entire width or height of a dock, but should
+ for creating panes that span the entire width or height of a dock, but should
not be resizable in the other direction.
*/
wxAuiPaneInfo DockFixed(bool b = true);
not be resizable in the other direction.
*/
wxAuiPaneInfo DockFixed(bool b = true);
/**
Layer() determines the layer of the docked pane. The dock layer is similar to
/**
Layer() determines the layer of the docked pane. The dock layer is similar to
- an onion, the inner-most layer being layer 0. Each shell moving in the outward
- direction has a higher layer number. This allows for more complex docking layout
+ an onion, the inner-most layer being layer 0. Each shell moving in the outward
+ direction has a higher layer number. This allows for more complex docking layout
formation.
*/
wxAuiPaneInfo Layer(int layer);
formation.
*/
wxAuiPaneInfo Layer(int layer);
/**
Name() sets the name of the pane so it can be referenced in lookup functions.
/**
Name() sets the name of the pane so it can be referenced in lookup functions.
- If a name is not specified by the user, a random name is assigned to the pane
+ If a name is not specified by the user, a random name is assigned to the pane
when it is added to the manager.
*/
wxAuiPaneInfo Name(const wxString& n);
when it is added to the manager.
*/
wxAuiPaneInfo Name(const wxString& n);
wxAuiPaneInfo TopDockable(bool b = true);
/**
wxAuiPaneInfo TopDockable(bool b = true);
/**
- Window() assigns the window pointer that the wxAuiPaneInfo should use.
- This normally does not need to be specified, as the window pointer is
- automatically assigned to the wxAuiPaneInfo structure as soon as it is added
+ Window() assigns the window pointer that the wxAuiPaneInfo should use.
+ This normally does not need to be specified, as the window pointer is
+ automatically assigned to the wxAuiPaneInfo structure as soon as it is added
to the manager.
*/
wxAuiPaneInfo Window(wxWindow* w);
to the manager.
*/
wxAuiPaneInfo Window(wxWindow* w);
projects / wxWidgets.git / commitdiff
