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

fix doxygen warnings

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57285 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-12-12 16:10:08 +00:00
parent 3e23102435
commit e2c4ccaf8a
5 changed files with 91 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
interface/wx/headerctrl.h
View File

@@ -40,80 +40,6 @@
This control is implemented using the native header control under MSW
systems and a generic implementation elsewhere.
@beginStyleTable
@style{wxHD_DRAGDROP}
If this style is specified (it is by default), the user can reorder
the control columns by dragging them.
@style{wxHD_DEFAULT_STYLE}
Symbolic name for the default control style, currently equal to @c
wxHD_DRAGDROP.
@endStyleTable
@beginEventTable{wxHeaderCtrlEvent}
@event{EVT_HEADER_CLICK(id, func)}
A column heading was clicked.
@event{EVT_HEADER_RIGHT_CLICK(id, func)}
A column heading was right clicked.
@event{EVT_HEADER_MIDDLE_CLICK(id, func)}
A column heading was clicked with the middle mouse button.
@event{EVT_HEADER_DCLICK(id, func)}
A column heading was double clicked.
@event{EVT_HEADER_RIGHT_DCLICK(id, func)}
A column heading was right double clicked.
@event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
A column heading was double clicked with the middle mouse button.
@event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
Separator to the right of the specified column was double clicked
(this action is commonly used to resize the column to fit its
contents width and the control provides UpdateColumnWidthToFit() method
to make implementing this easier).
@event{EVT_HEADER_BEGIN_RESIZE(id, func)}
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
which wxHeaderColumn::IsResizeable() returns true). The event can
be vetoed to prevent the column from being resized. If it isn't,
the resizing and end resize (or dragging cancelled) events will be
generated later.
@event{EVT_HEADER_RESIZING(id, func)}
The user is dragging the column with the specified index resizing
it and its current width is wxHeaderCtrlEvent::GetWidth(). The
event can be vetoed to stop the dragging operation completely at
any time.
@event{EVT_HEADER_END_RESIZE(id, func)}
The user stopped dragging the column by releasing the mouse. The
column should normally be resized to the value of
wxHeaderCtrlEvent::GetWidth().
@event{EVT_HEADER_BEGIN_REORDER(id, func)}
The user started to drag the column with the specified index (this
can only happen for the controls with wxHD_DRAGDROP style). This
event can be vetoed to prevent the column from being reordered,
otherwise the end reorder message will be generated later.
@event{EVT_HEADER_END_REORDER(id, func)}
The user dropped the column in its new location. The event can be
vetoed to prevent the column from being placed at the new position
or handled to update the display of the data in the associated
control to match the new column location (available from
wxHeaderCtrlEvent::GetNewOrder()).
@event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
The resizing or reordering operation currently in progress was
cancelled. This can happen if the user pressed Esc key while
dragging the mouse or the mouse capture was lost for some other
reason. You only need to handle this event if your application
entered into some modal mode when resizing or reordering began, in
which case it should handle this event in addition to the matching
end resizing or reordering ones.
@endEventTable
@library{wxcore}
@category{ctrl}
@see wxGrid, wxListCtrl, wxDataViewCtrl
@section headerctrl_improvements Future Improvements
@@ -124,6 +50,76 @@
- Displaying bitmaps instead of or together with the text
- Custom drawn headers
- Filters associated with a column.
@beginStyleTable
@style{wxHD_DRAGDROP}
If this style is specified (it is by default), the user can reorder
the control columns by dragging them.
@style{wxHD_DEFAULT_STYLE}
Symbolic name for the default control style, currently equal to
@c wxHD_DRAGDROP.
@endStyleTable
@beginEventTable{wxHeaderCtrlEvent}
@event{EVT_HEADER_CLICK(id, func)}
A column heading was clicked.
@event{EVT_HEADER_RIGHT_CLICK(id, func)}
A column heading was right clicked.
@event{EVT_HEADER_MIDDLE_CLICK(id, func)}
A column heading was clicked with the middle mouse button.
@event{EVT_HEADER_DCLICK(id, func)}
A column heading was double clicked.
@event{EVT_HEADER_RIGHT_DCLICK(id, func)}
A column heading was right double clicked.
@event{EVT_HEADER_MIDDLE_DCLICK(id, func)}
A column heading was double clicked with the middle mouse button.
@event{EVT_HEADER_SEPARATOR_DCLICK(id, func)}
Separator to the right of the specified column was double clicked
(this action is commonly used to resize the column to fit its
contents width and the control provides UpdateColumnWidthToFit() method
to make implementing this easier).
@event{EVT_HEADER_BEGIN_RESIZE(id, func)}
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
which wxHeaderColumn::IsResizeable() returns true). The event can
be vetoed to prevent the column from being resized. If it isn't,
the resizing and end resize (or dragging cancelled) events will be
generated later.
@event{EVT_HEADER_RESIZING(id, func)}
The user is dragging the column with the specified index resizing
it and its current width is wxHeaderCtrlEvent::GetWidth().
The event can be vetoed to stop the dragging operation completely at
any time.
@event{EVT_HEADER_END_RESIZE(id, func)}
The user stopped dragging the column by releasing the mouse.
The column should normally be resized to the value of
wxHeaderCtrlEvent::GetWidth().
@event{EVT_HEADER_BEGIN_REORDER(id, func)}
The user started to drag the column with the specified index (this
can only happen for the controls with wxHD_DRAGDROP style).
This event can be vetoed to prevent the column from being reordered,
otherwise the end reorder message will be generated later.
@event{EVT_HEADER_END_REORDER(id, func)}
The user dropped the column in its new location. The event can be
vetoed to prevent the column from being placed at the new position
or handled to update the display of the data in the associated
control to match the new column location (available from
wxHeaderCtrlEvent::GetNewOrder()).
@event{EVT_HEADER_DRAGGING_CANCELLED(id, func)}
The resizing or reordering operation currently in progress was
cancelled. This can happen if the user pressed Esc key while
dragging the mouse or the mouse capture was lost for some other
reason. You only need to handle this event if your application
entered into some modal mode when resizing or reordering began, in
which case it should handle this event in addition to the matching
end resizing or reordering ones.
@endEventTable
@library{wxcore}
@category{ctrl}
@see wxGrid, wxListCtrl, wxDataViewCtrl
*/
class wxHeaderCtrl
{
@@ -347,10 +343,13 @@ protected:
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
and will usually be used as a starting point for the fitting width
calculation.
@return
@true to indicate that the column was resized, i.e. GetColumn() now
returns the new width value, and so must be refreshed or @false

2
interface/wx/init.h
View File

@@ -13,7 +13,7 @@
Create an object of this class on the stack to initialize/cleanup the library
automatically.
@library{base}
@library{wxbase}
@category{appmanagement}
@see wxGLContext

3
interface/wx/intl.h
View File

@@ -410,6 +410,9 @@ public:
This overload takes two additional arguments, @a msgIdLanguage and @a msgIdCharset.
@param domain
The catalog domain to add.
@param msgIdLanguage
Specifies the language of "msgid" strings in source code
(i.e. arguments to GetString(), wxGetTranslation() and the _() macro).

4
interface/wx/listctrl.h
View File

@@ -891,8 +891,8 @@ protected:
/**
This function must be overloaded in the derived class for a control with
@c wxLC_VIRTUAL style having an @ref SetImageList() "image list"
(if the control doesn't have an image list, it is not necessary to overload it).
@c wxLC_VIRTUAL style having an "image list" (see SetImageList(); if the
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
or -1 for no image.

16
interface/wx/textfile.h
View File

@@ -99,16 +99,22 @@ public:
*/
bool Close();
//@{
/**
Creates the file with the given name or the name which was given in the
@ref wxTextFile() constructor. The array of file lines is initially empty.
Creates the file with the name which was given in the
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.
*/
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;
//@}
/**
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
@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.