AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed doxygen warnings produced by the ifacecheck fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56658 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-11-03 11:57:07 +00:00
parent 097a92e228
commit f21dd16b46
9 changed files with 130 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
interface/wx/filesys.h
View File

@ -100,7 +100,7 @@ public:
If the file is found in any directory, returns @true and the full path
of the file in @a str, otherwise returns @false and doesn't modify @a str.
@param str
@param pStr
Receives the full path of the file, must not be @NULL
@param path
wxPATH_SEP-separated list of directories

2
interface/wx/frame.h
View File

@ -386,7 +386,7 @@ public:
@param n
The number of fields in the status bar. It must be the
same used in CreateStatusBar.
@param widths
@param widths_field
Must contain an array of n integers, each of which is a status field width
in pixels. A value of -1 indicates that the field is variable width; at
least one field must be -1. You should delete this array after calling

154
interface/wx/html/htmlcell.h
View File

@ -6,62 +6,68 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxHtmlColourCell
This cell changes the colour of either the background or the foreground.
@library{wxhtml}
@category{html}
*/
class wxHtmlColourCell : public wxHtmlCell
{
public:
/**
Constructor.
@param clr
The color
@param flags
Can be one of following:
- wxHTML_CLR_FOREGROUND: change color of text
- wxHTML_CLR_BACKGROUND: change background color
*/
wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
};
/**
@class wxHtmlWidgetCell
@class wxHtmlRenderingStyle
wxHtmlWidgetCell is a class that provides a connection between HTML cells and
widgets (an object derived from wxWindow).
You can use it to display things like forms, input boxes etc. in an HTML window.
wxHtmlWidgetCell takes care of resizing and moving window.
Allows HTML rendering customizations.
This class is used when rendering wxHtmlCells as a callback.
@library{wxhtml}
@category{html}
@see wxHtmlRenderingInfo
*/
class wxHtmlWidgetCell : public wxHtmlCell
class wxHtmlRenderingStyle
{
public:
/**
Constructor.
@param wnd
Connected window. It is parent window @b must be the wxHtmlWindow object
within which it is displayed!
@param w
Floating width. If non-zero width of wnd window is adjusted so that it is
always w percents of parent container's width. (For example w = 100 means
that the window will always have same width as parent container).
Returns the colour to use for the selected text.
*/
wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
/**
Returns the colour to use for the selected text's background.
*/
virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
};
/**
@class wxHtmlRenderingInfo
This class contains information given to cells when drawing them.
Contains rendering state, selection information and rendering style object
that can be used to customize the output.
@library{wxhtml}
@category{html}
@see @ref overview_html_cells, wxHtmlCell
*/
class wxHtmlRenderingInfo
{
public:
/**
Default ctor.
*/
wxHtmlRenderingInfo();
//@{
/**
Accessors.
*/
void SetSelection(wxHtmlSelection *s);
wxHtmlSelection *GetSelection() const;
void SetStyle(wxHtmlRenderingStyle *style);
wxHtmlRenderingStyle& GetStyle();
wxHtmlRenderingState& GetState();
//@}
};
/**
@class wxHtmlCell
@ -107,7 +113,7 @@ public:
Renders the cell.
@param dc
Device context to which the cell is to be drawn
Device context to which the cell is to be drawn.
@param x,y
Coordinates of parent's upper left corner (origin). You must
add this to m_PosX,m_PosY when passing coordinates to dc's methods
@ -117,10 +123,12 @@ public:
@endcode
@param view_y1
y-coord of the first line visible in window.
This is used to optimize rendering speed
This is used to optimize rendering speed.
@param view_y2
y-coord of the last line visible in window.
This is used to optimize rendering speed
This is used to optimize rendering speed.
@param info
Additional information for the rendering of the cell.
*/
virtual void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2, wxHtmlRenderingInfo& info);
@ -138,8 +146,10 @@ public:
@code
dc->DrawText("hello", x + m_PosX, y + m_PosY)
@endcode
@param info
Additional information for the rendering of the cell.
*/
virtual void DrawInvisible(wxDC& cd, int x , int y, wxHtmlRenderingInfo& info);
virtual void DrawInvisible(wxDC& dc, int x , int y, wxHtmlRenderingInfo& info);
/**
Returns pointer to itself if this cell matches condition (or if any of the
@ -537,3 +547,57 @@ public:
wxString GetTarget() const;
};
/**
@class wxHtmlColourCell
This cell changes the colour of either the background or the foreground.
@library{wxhtml}
@category{html}
*/
class wxHtmlColourCell : public wxHtmlCell
{
public:
/**
Constructor.
@param clr
The color
@param flags
Can be one of following:
- wxHTML_CLR_FOREGROUND: change color of text
- wxHTML_CLR_BACKGROUND: change background color
*/
wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
};
/**
@class wxHtmlWidgetCell
wxHtmlWidgetCell is a class that provides a connection between HTML cells and
widgets (an object derived from wxWindow).
You can use it to display things like forms, input boxes etc. in an HTML window.
wxHtmlWidgetCell takes care of resizing and moving window.
@library{wxhtml}
@category{html}
*/
class wxHtmlWidgetCell : public wxHtmlCell
{
public:
/**
Constructor.
@param wnd
Connected window. It is parent window @b must be the wxHtmlWindow object
within which it is displayed!
@param w
Floating width. If non-zero width of wnd window is adjusted so that it is
always w percents of parent container's width. (For example w = 100 means
that the window will always have same width as parent container).
*/
wxHtmlWidgetCell(wxWindow* wnd, int w = 0);
};

10
interface/wx/html/htmprint.h
View File

@ -36,12 +36,16 @@ public:
Renders HTML text to the DC.
@param x,y
position of upper-left corner of printing rectangle (see SetSize())
position of upper-left corner of printing rectangle (see SetSize()).
@param known_pagebreaks
@todo docme
@param from
y-coordinate of the very first visible cell
y-coordinate of the very first visible cell.
@param dont_render
if @true then this method only returns y coordinate of the next page
and does not output anything
and does not output anything.
@param to
y-coordinate of the last visible cell.
Returned value is y coordinate of first cell than didn't fit onto page.
Use this value as from in next call to Render() in order to print multipages document.

3
interface/wx/image.h
View File

@ -119,6 +119,9 @@ public:
The image object which is to be affected by this operation.
@param stream
Opened output stream for writing the data.
@param verbose
If set to @true, errors reported by the image handler will produce
wxLogMessages.
@return @true if the operation succeeded, @false otherwise.

4
interface/wx/log.h
View File

@ -26,9 +26,9 @@ public:
/**
Creates the log frame window and starts collecting the messages in it.
@param parent
@param pParent
The parent window for the log frame, may be @NULL
@param title
@param szTitle
The title for the log frame
@param show
@true to show the frame initially (default), otherwise

9
interface/wx/radiobox.h
View File

@ -186,15 +186,16 @@ public:
*/
virtual bool Enable(unsigned int n, bool enable = true);
/**
Finds a button matching the given string, returning the position if found, or
-1 if not found.
Finds a button matching the given string, returning the position if found,
or @c wxNOT_FOUND if not found.
@param string
The string to find.
@param bCase
Should the search be case-sensitive?
*/
virtual int FindString(const wxString& s, bool bCase = false) const;
virtual int FindString(const wxString& string, bool bCase = false) const;
/**
Returns the number of columns in the radiobox.

2
interface/wx/sizer.h
View File

@ -401,7 +401,7 @@ public:
This method replaces the previously set alignment with the specified one.
@param align
@param alignment
Combination of @c wxALIGN_XXX bit masks.
@see Top(), Left(), Right(), Bottom(), Centre()

2
interface/wx/statusbr.h
View File

@ -180,7 +180,7 @@ public:
@param n
The number of fields in the status bar. Must be equal to the
number passed to SetFieldsCount() the last time it was called.
@param widths
@param widths_field
Contains an array of n integers, each of which is either an
absolute status field width in pixels if positive or indicates a
variable width field if negative.