fix doxygen warnings
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57285 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -40,13 +40,25 @@
|
|||||||
This control is implemented using the native header control under MSW
|
This control is implemented using the native header control under MSW
|
||||||
systems and a generic implementation elsewhere.
|
systems and a generic implementation elsewhere.
|
||||||
|
|
||||||
|
|
||||||
|
@section headerctrl_improvements Future Improvements
|
||||||
|
|
||||||
|
Some features are supported by the native MSW control and so could be
|
||||||
|
easily implemented in this version of wxHeaderCtrl but need to be
|
||||||
|
implemented in the generic version as well to be really useful. Please let
|
||||||
|
us know if you need or, better, plan to work on implementing, any of them:
|
||||||
|
- Displaying bitmaps instead of or together with the text
|
||||||
|
- Custom drawn headers
|
||||||
|
- Filters associated with a column.
|
||||||
|
|
||||||
|
|
||||||
@beginStyleTable
|
@beginStyleTable
|
||||||
@style{wxHD_DRAGDROP}
|
@style{wxHD_DRAGDROP}
|
||||||
If this style is specified (it is by default), the user can reorder
|
If this style is specified (it is by default), the user can reorder
|
||||||
the control columns by dragging them.
|
the control columns by dragging them.
|
||||||
@style{wxHD_DEFAULT_STYLE}
|
@style{wxHD_DEFAULT_STYLE}
|
||||||
Symbolic name for the default control style, currently equal to @c
|
Symbolic name for the default control style, currently equal to
|
||||||
wxHD_DRAGDROP.
|
@c wxHD_DRAGDROP.
|
||||||
@endStyleTable
|
@endStyleTable
|
||||||
|
|
||||||
@beginEventTable{wxHeaderCtrlEvent}
|
@beginEventTable{wxHeaderCtrlEvent}
|
||||||
@@ -56,20 +68,17 @@
|
|||||||
A column heading was right clicked.
|
A column heading was right clicked.
|
||||||
@event{EVT_HEADER_MIDDLE_CLICK(id, func)}
|
@event{EVT_HEADER_MIDDLE_CLICK(id, func)}
|
||||||
A column heading was clicked with the middle mouse button.
|
A column heading was clicked with the middle mouse button.
|
||||||
|
|
||||||
@event{EVT_HEADER_DCLICK(id, func)}
|
@event{EVT_HEADER_DCLICK(id, func)}
|
||||||
A column heading was double clicked.
|
A column heading was double clicked.
|
||||||
@event{EVT_HEADER_RIGHT_DCLICK(id, func)}
|
@event{EVT_HEADER_RIGHT_DCLICK(id, func)}
|
||||||
A column heading was right double clicked.
|
A column heading was right double clicked.
|
||||||
@event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
|
@event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
|
||||||
A column heading was double clicked with the middle mouse button.
|
A column heading was double clicked with the middle mouse button.
|
||||||
|
|
||||||
@event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
|
@event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
|
||||||
Separator to the right of the specified column was double clicked
|
Separator to the right of the specified column was double clicked
|
||||||
(this action is commonly used to resize the column to fit its
|
(this action is commonly used to resize the column to fit its
|
||||||
contents width and the control provides UpdateColumnWidthToFit() method
|
contents width and the control provides UpdateColumnWidthToFit() method
|
||||||
to make implementing this easier).
|
to make implementing this easier).
|
||||||
|
|
||||||
@event{EVT_HEADER_BEGIN_RESIZE(id, func)}
|
@event{EVT_HEADER_BEGIN_RESIZE(id, func)}
|
||||||
The user started to drag the separator to the right of the column
|
The user started to drag the separator to the right of the column
|
||||||
with the specified index (this can only happen for the columns for
|
with the specified index (this can only happen for the columns for
|
||||||
@@ -79,18 +88,17 @@
|
|||||||
generated later.
|
generated later.
|
||||||
@event{EVT_HEADER_RESIZING(id, func)}
|
@event{EVT_HEADER_RESIZING(id, func)}
|
||||||
The user is dragging the column with the specified index resizing
|
The user is dragging the column with the specified index resizing
|
||||||
it and its current width is wxHeaderCtrlEvent::GetWidth(). The
|
it and its current width is wxHeaderCtrlEvent::GetWidth().
|
||||||
event can be vetoed to stop the dragging operation completely at
|
The event can be vetoed to stop the dragging operation completely at
|
||||||
any time.
|
any time.
|
||||||
@event{EVT_HEADER_END_RESIZE(id, func)}
|
@event{EVT_HEADER_END_RESIZE(id, func)}
|
||||||
The user stopped dragging the column by releasing the mouse. The
|
The user stopped dragging the column by releasing the mouse.
|
||||||
column should normally be resized to the value of
|
The column should normally be resized to the value of
|
||||||
wxHeaderCtrlEvent::GetWidth().
|
wxHeaderCtrlEvent::GetWidth().
|
||||||
|
|
||||||
@event{EVT_HEADER_BEGIN_REORDER(id, func)}
|
@event{EVT_HEADER_BEGIN_REORDER(id, func)}
|
||||||
The user started to drag the column with the specified index (this
|
The user started to drag the column with the specified index (this
|
||||||
can only happen for the controls with wxHD_DRAGDROP style). This
|
can only happen for the controls with wxHD_DRAGDROP style).
|
||||||
event can be vetoed to prevent the column from being reordered,
|
This event can be vetoed to prevent the column from being reordered,
|
||||||
otherwise the end reorder message will be generated later.
|
otherwise the end reorder message will be generated later.
|
||||||
@event{EVT_HEADER_END_REORDER(id, func)}
|
@event{EVT_HEADER_END_REORDER(id, func)}
|
||||||
The user dropped the column in its new location. The event can be
|
The user dropped the column in its new location. The event can be
|
||||||
@@ -98,7 +106,6 @@
|
|||||||
or handled to update the display of the data in the associated
|
or handled to update the display of the data in the associated
|
||||||
control to match the new column location (available from
|
control to match the new column location (available from
|
||||||
wxHeaderCtrlEvent::GetNewOrder()).
|
wxHeaderCtrlEvent::GetNewOrder()).
|
||||||
|
|
||||||
@event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
|
@event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
|
||||||
The resizing or reordering operation currently in progress was
|
The resizing or reordering operation currently in progress was
|
||||||
cancelled. This can happen if the user pressed Esc key while
|
cancelled. This can happen if the user pressed Esc key while
|
||||||
@@ -113,17 +120,6 @@
|
|||||||
@category{ctrl}
|
@category{ctrl}
|
||||||
|
|
||||||
@see wxGrid, wxListCtrl, wxDataViewCtrl
|
@see wxGrid, wxListCtrl, wxDataViewCtrl
|
||||||
|
|
||||||
|
|
||||||
@section headerctrl_improvements Future Improvements
|
|
||||||
|
|
||||||
Some features are supported by the native MSW control and so could be
|
|
||||||
easily implemented in this version of wxHeaderCtrl but need to be
|
|
||||||
implemented in the generic version as well to be really useful. Please let
|
|
||||||
us know if you need or, better, plan to work on implementing, any of them:
|
|
||||||
- Displaying bitmaps instead of or together with the text
|
|
||||||
- Custom drawn headers
|
|
||||||
- Filters associated with a column.
|
|
||||||
*/
|
*/
|
||||||
class wxHeaderCtrl
|
class wxHeaderCtrl
|
||||||
{
|
{
|
||||||
@@ -347,10 +343,13 @@ protected:
|
|||||||
|
|
||||||
Base class version simply returns @false.
|
Base class version simply returns @false.
|
||||||
|
|
||||||
@param width
|
@param idx
|
||||||
|
The zero-based index of the column to update.
|
||||||
|
@param widthTitle
|
||||||
Contains minimal width needed to display the column header itself
|
Contains minimal width needed to display the column header itself
|
||||||
and will usually be used as a starting point for the fitting width
|
and will usually be used as a starting point for the fitting width
|
||||||
calculation.
|
calculation.
|
||||||
|
|
||||||
@return
|
@return
|
||||||
@true to indicate that the column was resized, i.e. GetColumn() now
|
@true to indicate that the column was resized, i.e. GetColumn() now
|
||||||
returns the new width value, and so must be refreshed or @false
|
returns the new width value, and so must be refreshed or @false
|
||||||
|
@@ -13,7 +13,7 @@
|
|||||||
Create an object of this class on the stack to initialize/cleanup the library
|
Create an object of this class on the stack to initialize/cleanup the library
|
||||||
automatically.
|
automatically.
|
||||||
|
|
||||||
@library{base}
|
@library{wxbase}
|
||||||
@category{appmanagement}
|
@category{appmanagement}
|
||||||
|
|
||||||
@see wxGLContext
|
@see wxGLContext
|
||||||
|
@@ -410,6 +410,9 @@ public:
|
|||||||
|
|
||||||
This overload takes two additional arguments, @a msgIdLanguage and @a msgIdCharset.
|
This overload takes two additional arguments, @a msgIdLanguage and @a msgIdCharset.
|
||||||
|
|
||||||
|
@param domain
|
||||||
|
The catalog domain to add.
|
||||||
|
|
||||||
@param msgIdLanguage
|
@param msgIdLanguage
|
||||||
Specifies the language of "msgid" strings in source code
|
Specifies the language of "msgid" strings in source code
|
||||||
(i.e. arguments to GetString(), wxGetTranslation() and the _() macro).
|
(i.e. arguments to GetString(), wxGetTranslation() and the _() macro).
|
||||||
|
@@ -891,8 +891,8 @@ protected:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
This function must be overloaded in the derived class for a control with
|
This function must be overloaded in the derived class for a control with
|
||||||
@c wxLC_VIRTUAL style having an @ref SetImageList() "image list"
|
@c wxLC_VIRTUAL style having an "image list" (see SetImageList(); if the
|
||||||
(if the control doesn't have an image list, it is not necessary to overload it).
|
control doesn't have an image list, it is not necessary to overload it).
|
||||||
It should return the index of the items image in the controls image list
|
It should return the index of the items image in the controls image list
|
||||||
or -1 for no image.
|
or -1 for no image.
|
||||||
|
|
||||||
|
@@ -99,16 +99,22 @@ public:
|
|||||||
*/
|
*/
|
||||||
bool Close();
|
bool Close();
|
||||||
|
|
||||||
//@{
|
|
||||||
/**
|
/**
|
||||||
Creates the file with the given name or the name which was given in the
|
Creates the file with the name which was given in the
|
||||||
@ref wxTextFile() constructor. The array of file lines is initially empty.
|
wxTextFile(const wxString&) constructor.
|
||||||
|
The array of file lines is initially empty.
|
||||||
|
|
||||||
It will fail if the file already exists, Open() should be used in this case.
|
It will fail if the file already exists, Open() should be used in this case.
|
||||||
*/
|
*/
|
||||||
bool Create() const;
|
bool Create() const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Creates the file with the given name.
|
||||||
|
The array of file lines is initially empty.
|
||||||
|
|
||||||
|
It will fail if the file already exists, Open() should be used in this case.
|
||||||
|
*/
|
||||||
bool Create(const wxString& strFile) const;
|
bool Create(const wxString& strFile) const;
|
||||||
//@}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Returns @true if the current line is the last one.
|
Returns @true if the current line is the last one.
|
||||||
@@ -239,7 +245,7 @@ public:
|
|||||||
//@{
|
//@{
|
||||||
/**
|
/**
|
||||||
Open() opens the file with the given name or the name which was given in the
|
Open() opens the file with the given name or the name which was given in the
|
||||||
@ref wxTextFile() constructor and also loads file in memory on success.
|
wxTextFile(const wxString&) constructor and also loads file in memory on success.
|
||||||
|
|
||||||
It will fail if the file does not exist, Create() should be used in this case.
|
It will fail if the file does not exist, Create() should be used in this case.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user