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

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
interface/html/helpctrl.h
View File

@@ -9,37 +9,37 @@
/**
@class wxHtmlHelpController
@headerfile helpctrl.h wx/html/helpctrl.h
This help controller provides an easy way of displaying HTML help in your
application (see @e test sample). The help system is based on @b books
application (see @e test sample). The help system is based on @b books
(see wxHtmlHelpController::AddBook). A book is a logical
section of documentation (for example "User's Guide" or "Programmer's Guide" or
"C++ Reference" or "wxWidgets Reference"). The help controller can handle as
many books as you want.
Although this class has an API compatible with other wxWidgets
help controllers as documented by wxHelpController, it
is recommended that you use the enhanced capabilities of wxHtmlHelpController's
API.
wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as
its
native format. The file format is described here.
Have a look at docs/html/ directory where sample project files are stored.
You can use Tex2RTF to produce these files when generating HTML, if you set @b
htmlWorkshopFiles to @b @true in
your tex2rtf.ini file. The commercial tool HelpBlocks (www.helpblocks.com) can
also create these files.
@library{wxhtml}
@category{help}
@seealso
@ref overview_wxhelpcontroller "Information about wxBestHelpController",
wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp
*/
class wxHtmlHelpController
class wxHtmlHelpController
{
public:
/**
@@ -55,25 +55,25 @@ public:
This must be called at least once before displaying any help.
@e bookFile or @e bookUrl may be either .hhp file or ZIP archive
that contains arbitrary number of .hhp files in
that contains arbitrary number of .hhp files in
top-level directory. This ZIP archive must have .zip or .htb extension
(the latter stands for "HTML book"). In other words, @c
AddBook(wxFileName("help.zip"))
AddBook(wxFileName("help.zip"))
is possible and is the recommended way.
@param showWaitMsg
@param showWaitMsg
If @true then a decoration-less window with progress message is displayed.
@param bookFile
@param bookFile
Help book filename. It is recommended to use this prototype
instead of the one taking URL, because it is less error-prone.
@param bookUrl
Help book URL (note that syntax of filename and URL is
@param bookUrl
Help book URL (note that syntax of filename and URL is
different on most platforms)
*/
bool AddBook(const wxFileName& bookFile, bool showWaitMsg);
bool AddBook(const wxString& bookUrl, bool showWaitMsg);
bool AddBook(const wxString& bookUrl, bool showWaitMsg);
//@}
/**
@@ -94,7 +94,7 @@ public:
This alternative form is used to search help contents by numeric IDs.
*/
void Display(const wxString& x);
void Display(const int id);
void Display(const int id);
//@}
/**
@@ -128,10 +128,10 @@ public:
Sets the path for storing temporary files - cached binary versions of index and
contents files. These binary
forms are much faster to read. Default value is empty string (empty string means
that no cached data are stored). Note that these files are @e not
that no cached data are stored). Note that these files are @e not
deleted when program exits.
Once created these cached files will be used in all subsequent executions
Once created these cached files will be used in all subsequent executions
of your application. If cached files become older than corresponding .hhp
file (e.g. if you regenerate documentation) it will be refreshed.
*/
@@ -151,9 +151,9 @@ public:
The only thing you must do is create wxConfig object and call UseConfig.
If you do not use @e UseConfig, wxHtmlHelpController will use
default wxConfig object if available (for details see
wxConfigBase::Get and
If you do not use @e UseConfig, wxHtmlHelpController will use
default wxConfig object if available (for details see
wxConfigBase::Get and
wxConfigBase::Set).
*/
void UseConfig(wxConfigBase* config,
@@ -170,39 +170,39 @@ public:
/**
@class wxHtmlModalHelp
@headerfile helpctrl.h wx/html/helpctrl.h
This class uses wxHtmlHelpController
This class uses wxHtmlHelpController
to display help in a modal dialog. This is useful on platforms such as wxMac
where if you display help from a modal dialog, the help window must itself be a
modal
dialog.
Create objects of this class on the stack, for example:
@code
// The help can be browsed during the lifetime of this object; when the user
quits
// the help, program execution will continue.
wxHtmlModalHelp help(parent, wxT("help"), wxT("My topic"));
@endcode
@library{wxhtml}
@category{FIXME}
*/
class wxHtmlModalHelp
class wxHtmlModalHelp
{
public:
/**
@param parent
@param parent
is the parent of the dialog.
@param helpFile
@param helpFile
is the HTML help file to show.
@param topic
@param topic
is an optional topic. If this is empty, the help contents will be shown.
@param style
@param style
is a combination of the flags described in the wxHtmlHelpController
documentation.
*/

8
interface/html/helpdata.h
View File

@@ -9,12 +9,12 @@
/**
@class wxHtmlHelpData
@headerfile helpdata.h wx/html/helpdata.h
This class is used by wxHtmlHelpController
This class is used by wxHtmlHelpController
and wxHtmlHelpFrame to access HTML help items.
It is internal class and should not be used directly - except for the case
It is internal class and should not be used directly - except for the case
you're writing your own HTML help controller.
@library{wxhtml}
@category{FIXME}
*/

14
interface/html/helpdlg.h
View File

@@ -9,12 +9,12 @@
/**
@class wxHtmlHelpDialog
@headerfile helpdlg.h wx/html/helpdlg.h
This class is used by wxHtmlHelpController
This class is used by wxHtmlHelpController
to display help.
It is an internal class and should not be used directly - except for the case
when you're writing your own HTML help controller.
@library{wxhtml}
@category{FIXME}
*/
@@ -27,10 +27,10 @@ public:
wxHtmlHelpController.
*/
wxHtmlHelpDialog(wxHtmlHelpData* data = @NULL);
wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
//@}
/**

14
interface/html/helpfrm.h
View File

@@ -9,12 +9,12 @@
/**
@class wxHtmlHelpFrame
@headerfile helpfrm.h wx/html/helpfrm.h
This class is used by wxHtmlHelpController
This class is used by wxHtmlHelpController
to display help.
It is an internal class and should not be used directly - except for the case
when you're writing your own HTML help controller.
@library{wxhtml}
@category{FIXME}
*/
@@ -27,10 +27,10 @@ public:
wxHtmlHelpController.
*/
wxHtmlHelpFrame(wxHtmlHelpData* data = @NULL);
wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
//@}
/**

32
interface/html/helpwnd.h
View File

@@ -9,32 +9,32 @@
/**
@class wxHtmlHelpWindow
@headerfile helpwnd.h wx/html/helpwnd.h
This class is used by wxHtmlHelpController
This class is used by wxHtmlHelpController
to display help within a frame or dialog, but you can use it yourself to create
an embedded HTML help window.
For example:
@code
// m_embeddedHelpWindow is a wxHtmlHelpWindow
// m_embeddedHtmlHelp is a wxHtmlHelpController
// Create embedded HTML Help window
m_embeddedHelpWindow = new wxHtmlHelpWindow;
m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config
object here
m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
m_embeddedHelpWindow-Create(this,
wxID_ANY, wxDefaultPosition, GetClientSize(),
wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
@endcode
You should pass the style wxHF_EMBEDDED to the style parameter of
wxHtmlHelpController to allow
the embedded window to be destroyed independently of the help controller.
@library{wxhtml}
@category{FIXME}
*/
@@ -49,12 +49,12 @@ public:
wxHtmlHelpController.
*/
wxHtmlHelpWindow(wxHtmlHelpData* data = @NULL);
wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
const wxPoint& pos = wxDefaultPosition,
const wxSize& pos = wxDefaultSize,
int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
int helpStyle = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
const wxPoint& pos = wxDefaultPosition,
const wxSize& pos = wxDefaultSize,
int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
int helpStyle = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = @NULL);
//@}
/**
@@ -113,7 +113,7 @@ public:
(uses extension to MS format, param name="ID" value=id)
*/
bool Display(const wxString& x);
bool Display(const int id);
bool Display(const int id);
//@}
/**

110
interface/html/htmlcell.h
View File

@@ -9,9 +9,9 @@
/**
@class wxHtmlColourCell
@headerfile htmlcell.h wx/html/htmlcell.h
This cell changes the colour of either the background or the foreground.
This cell changes the colour of either the background or the foreground.
@library{wxhtml}
@category{FIXME}
*/
@@ -21,10 +21,10 @@ public:
/**
Constructor.
@param clr
@param clr
The color
@param flags
@param flags
Can be one of following:
wxHTML_CLR_FOREGROUND
@@ -44,14 +44,14 @@ public:
/**
@class wxHtmlWidgetCell
@headerfile htmlcell.h wx/html/htmlcell.h
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{FIXME}
*/
@@ -61,11 +61,11 @@ public:
/**
Constructor.
@param wnd
@param wnd
Connected window. It is parent window must be the wxHtmlWindow object within
which it is displayed!
@param w
@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
@@ -78,19 +78,19 @@ public:
/**
@class wxHtmlCell
@headerfile htmlcell.h wx/html/htmlcell.h
Internal data structure. It represents fragments of parsed HTML
page, the so-called @b cell - a word, picture, table, horizontal line and so on.
It is used by wxHtmlWindow and
It is used by wxHtmlWindow and
wxHtmlWinParser to represent HTML page in memory.
You can divide cells into two groups : @e visible cells with non-zero width and
height and @e helper cells (usually with zero width and height) that
perform special actions such as color or font change.
@library{wxhtml}
@category{FIXME}
@seealso
@ref overview_cells "Cells Overview", wxHtmlContainerCell
*/
@@ -118,19 +118,19 @@ public:
/**
Renders the cell.
@param dc
@param dc
Device context to which the cell is to be drawn
@param x,y
@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
Example : dc - DrawText("hello", x + m_PosX, y + m_PosY)
@param view_y1
@param view_y1
y-coord of the first line visible in window. This is
used to optimize rendering speed
@param view_y2
@param view_y2
y-coord of the last line visible in window. This is
used to optimize rendering speed
*/
@@ -143,10 +143,10 @@ public:
nonsense - some tags (like wxHtmlColourCell
or font setter) must be drawn even if they are invisible!
@param dc
@param dc
Device context to which the cell is to be drawn
@param x,y
@param x,y
Coordinates of parent's upper left corner. You must
add this to m_PosX,m_PosY when passing coordinates to dc's methods
Example : dc - DrawText("hello", x + m_PosX, y + m_PosY)
@@ -163,16 +163,16 @@ public:
to cell of some type (e.g. wxHtmlAnchorCell reacts on
wxHTML_COND_ISANCHOR condition)
@param condition
@param condition
Unique integer identifier of condition
@param param
@param param
Optional parameters
*/
virtual const wxHtmlCell* Find(int condition, const void* param);
/**
Returns descent value of the cell (m_Descent member).
Returns descent value of the cell (m_Descent member).
See explanation:
*/
int GetDescent();
@@ -203,7 +203,7 @@ public:
See wxHtmlLinkInfo.
(Note: this makes sense only for visible tags).
@param x,y
@param x,y
Coordinates of position where the user pressed mouse button.
These coordinates are used e.g. by COLORMAP. Values are relative to the
upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)
@@ -213,7 +213,7 @@ public:
/**
Returns cursor to show when mouse pointer is over the cell.
@param window
@param window
interface to the parent HTML window
*/
virtual wxCursor GetMouseCursor(wxHtmlWindowInterface* window);
@@ -269,13 +269,13 @@ public:
cell is called. Default behavior is to call
wxHtmlWindow::LoadPage.
@param window
@param window
interface to the parent HTML window
@param pos
@param pos
coordinates of mouse click (this is relative to cell's origin
@param event
@param event
mouse event that triggered the call
@returns @true if a link was clicked, @false otherwise.
@@ -317,13 +317,13 @@ public:
/**
@class wxHtmlContainerCell
@headerfile htmlcell.h wx/html/htmlcell.h
The wxHtmlContainerCell class is an implementation of a cell that may
contain more cells in it. It is heavily used in the wxHTML layout algorithm.
@library{wxhtml}
@category{FIXME}
@seealso
@ref overview_cells "Cells Overview"
*/
@@ -355,7 +355,7 @@ public:
/**
Returns the indentation. @e ind is one of the @b wxHTML_INDENT_* constants.
@b Note: You must call GetIndentUnits()
@b Note: You must call GetIndentUnits()
with same @e ind parameter in order to correctly interpret the returned integer
value.
It is NOT always in pixels!
@@ -376,16 +376,16 @@ public:
/**
Sets the container's alignment (both horizontal and vertical) according to
the values stored in @e tag. (Tags @c ALIGN parameter is extracted.) In fact
it is only a front-end to SetAlignHor()
it is only a front-end to SetAlignHor()
and SetAlignVer().
*/
void SetAlign(const wxHtmlTag& tag);
/**
Sets the container's @e horizontal alignment. During wxHtmlCell::Layout
Sets the container's @e horizontal alignment. During wxHtmlCell::Layout
each line is aligned according to @e al value.
@param al
@param al
new horizontal alignment. May be one of these values:
wxHTML_ALIGN_LEFT
@@ -413,7 +413,7 @@ public:
/**
Sets the container's @e vertical alignment. This is per-line alignment!
@param al
@param al
new vertical alignment. May be one of these values:
wxHTML_ALIGN_BOTTOM
@@ -441,10 +441,10 @@ public:
/**
Sets the border (frame) colours. A border is a rectangle around the container.
@param clr1
@param clr1
Colour of top and left lines
@param clr2
@param clr2
Colour of bottom and right lines
*/
void SetBorder(const wxColour& clr1, const wxColour& clr2);
@@ -452,10 +452,10 @@ public:
/**
Sets the indentation (free space between borders of container and subcells).
@param i
@param i
Indentation value.
@param what
@param what
Determines which of the four borders we're setting. It is OR
combination of following constants:
@@ -495,7 +495,7 @@ public:
all 4 borders
@param units
@param units
Units of i. This parameter affects interpretation of value.
wxHTML_UNITS_PIXELS
@@ -520,10 +520,10 @@ public:
of container is never smaller than @e h - even if the subcells cover
much smaller area.
@param h
@param h
The minimal height.
@param align
@param align
If height of the container is lower than the minimum height, empty space must
be inserted
somewhere in order to ensure minimal height. This parameter is one of
@@ -543,14 +543,14 @@ public:
@e pixel_scale is number of real pixels that equals to 1 HTML pixel.
@param w
@param w
Width of the container. If the value is negative it means
complement to full width of parent container (e.g.
SetWidthFloat(-50, wxHTML_UNITS_PIXELS) sets the width
of container to parent's width minus 50 pixels. This is useful when
creating tables - you can call SetWidthFloat(50) and SetWidthFloat(-50))
@param units
@param units
Units of w This parameter affects the interpretation of value.
wxHTML_UNITS_PIXELS
@@ -564,13 +564,13 @@ public:
w is interpreted as percents of width
of parent container
@param tag
@param tag
In the second version of method, w and units
info is extracted from tag's WIDTH parameter.
*/
void SetWidthFloat(int w, int units);
void SetWidthFloat(const wxHtmlTag& tag,
double pixel_scale = 1.0);
void SetWidthFloat(const wxHtmlTag& tag,
double pixel_scale = 1.0);
//@}
};
@@ -578,12 +578,12 @@ public:
/**
@class wxHtmlLinkInfo
@headerfile htmlcell.h wx/html/htmlcell.h
This class stores all necessary information about hypertext
links (as represented by @c A tag in HTML documents). In
current implementation it stores URL and target frame name.
links (as represented by @c A tag in HTML documents). In
current implementation it stores URL and target frame name.
@e Note that frames are not currently supported by wxHTML!
@library{wxhtml}
@category{FIXME}
*/
@@ -596,8 +596,8 @@ public:
frame).
*/
wxHtmlLinkInfo();
wxHtmlLinkInfo(const wxString& href,
const wxString& target = wxEmptyString);
wxHtmlLinkInfo(const wxString& href,
const wxString& target = wxEmptyString);
//@}
/**

6
interface/html/htmlfilt.h
View File

@@ -9,13 +9,13 @@
/**
@class wxHtmlFilter
@headerfile htmlfilt.h wx/html/htmlfilt.h
This class is the parent class of input filters for wxHtmlWindow.
It allows you to read and display files of different file formats.
@library{wxhtml}
@category{FIXME}
@seealso
Overview
*/

40
interface/html/htmlpars.h
View File

@@ -9,11 +9,11 @@
/**
@class wxHtmlTagHandler
@headerfile htmlpars.h wx/html/htmlpars.h
@library{wxhtml}
@category{html}
@seealso
Overview, wxHtmlTag
*/
@@ -49,7 +49,7 @@ public:
void ParseInner(const wxHtmlTag& tag);
/**
Assigns @e parser to this handler. Each @b instance of handler
Assigns @e parser to this handler. Each @b instance of handler
is guaranteed to be called only from the parser.
*/
virtual void SetParser(wxHtmlParser parser);
@@ -66,33 +66,33 @@ public:
/**
@class wxHtmlParser
@headerfile htmlpars.h wx/html/htmlpars.h
Classes derived from this handle the @b generic parsing of HTML documents: it
scans
the document and divide it into blocks of tags (where one block
consists of beginning and ending tag and of text between these
two tags).
It is independent from wxHtmlWindow and can be used as stand-alone parser
(Julian Smart's idea of speech-only HTML viewer or wget-like utility -
see InetGet sample for example).
It uses system of tag handlers to parse the HTML document. Tag handlers
are not statically shared by all instances but are created for each
wxHtmlParser instance. The reason is that the handler may contain
document-specific temporary data used during parsing (e.g. complicated
structures like tables).
Typically the user calls only the wxHtmlParser::Parse method.
@library{wxhtml}
@category{html}
@seealso
@ref overview_cells "Cells Overview", @ref overview_handlers "Tag Handlers
Overview", wxHtmlTag
*/
class wxHtmlParser
class wxHtmlParser
{
public:
/**
@@ -103,7 +103,7 @@ public:
/**
This may (and may not) be overwritten in derived class.
This method is called each time new tag is about to be added.
This method is called each time new tag is about to be added.
@e tag contains information about the tag. (See wxHtmlTag
for details.)
@@ -142,7 +142,7 @@ public:
(in noparams version it parses whole m_Source)
*/
void DoParsing(int begin_pos, int end_pos);
void DoParsing();
void DoParsing();
//@}
/**
@@ -183,7 +183,7 @@ public:
point to any valid resource or the URL is blocked by overridden implementation
of @e OpenURL in derived class.
@param type
@param type
Indicates type of the resource. Is one of:
wxHTML_URL_PAGE
@@ -202,7 +202,7 @@ public:
Opening a resource that doesn't fall into
any other category.
@param url
@param url
URL being opened.
*/
virtual wxFSFile* OpenURL(wxHtmlURLType type,
@@ -225,20 +225,20 @@ public:
wxObject* Parse(const wxString& source);
/**
Restores parser's state before last call to
Restores parser's state before last call to
PushTagHandler().
*/
void PopTagHandler();
/**
Forces the handler to handle additional tags
(not returned by wxHtmlTagHandler::GetSupportedTags).
Forces the handler to handle additional tags
(not returned by wxHtmlTagHandler::GetSupportedTags).
The handler should already be added to this parser.
@param handler
@param handler
the handler
@param tags
@param tags
List of tags (in same format as GetSupportedTags's return value). The parser
will redirect these tags to handler (until call to PopTagHandler).
*/

28
interface/html/htmltag.h
View File

@@ -9,14 +9,14 @@
/**
@class wxHtmlTag
@headerfile htmltag.h wx/html/htmltag.h
This class represents a single HTML tag.
This class represents a single HTML tag.
It is used by @ref overview_handlers "tag handlers".
@library{wxhtml}
@category{FIXME}
*/
class wxHtmlTag
class wxHtmlTag
{
public:
/**
@@ -38,7 +38,7 @@ public:
/**
Returns beginning position of the text @e between this tag and paired
ending tag.
ending tag.
See explanation (returned position is marked with '|'):
*/
int GetBeginPos();
@@ -68,10 +68,10 @@ public:
Returns the value of the parameter. You should check whether the
parameter exists or not (use wxHtmlTag::HasParam) first.
@param par
@param par
The parameter's name.
@param with_quotes
@param with_quotes
@true if you want to get quotes as well. See example.
*/
wxString GetParam(const wxString& par, bool with_quotes = @false);
@@ -98,36 +98,36 @@ public:
Returns @true if this tag is paired with ending tag, @false otherwise.
See the example of HTML document:
In this example tags HTML and BODY have ending tags, first P and BR
In this example tags HTML and BODY have ending tags, first P and BR
doesn't have ending tag while the second P has. The third P tag (which
is ending itself) of course doesn't have ending tag.
*/
bool HasEnding();
/**
Returns @true if the tag has a parameter of the given name.
Returns @true if the tag has a parameter of the given name.
Example : @c FONT SIZE=+2 COLOR="#FF00FF" has two parameters named
"SIZE" and "COLOR".
@param par
@param par
the parameter you're looking for.
*/
bool HasParam(const wxString& par);
/**
This method scans the given parameter. Usage is exactly the same as sscanf's
This method scans the given parameter. Usage is exactly the same as sscanf's
usage except that you don't pass a string but a parameter name as the first
argument
and you can only retrieve one value (i.e. you can use only one "%" element
in @e format).
@param par
@param par
The name of the tag you want to query
@param format
@param format
scanf()-like format string.
@param value
@param value
pointer to a variable to store the value in
*/
wxString ScanParam(const wxString& par, const wxChar * format,

94
interface/html/htmlwin.h
View File

@@ -9,20 +9,20 @@
/**
@class wxHtmlWindow
@headerfile htmlwin.h wx/html/htmlwin.h
wxHtmlWindow is probably the only class you will directly use
unless you want to do something special (like adding new tag
handlers or MIME filters).
The purpose of this class is to display HTML pages (either local
file or downloaded via HTTP protocol) in a window. The width
of the window is constant - given in the constructor - and virtual height
is changed dynamically depending on page size.
Once the window is created you can set its content by calling
Once the window is created you can set its content by calling
@ref wxHtmlWindow::setpage SetPage(text),
@ref wxHtmlWindow::loadpage LoadPage(filename) or
wxHtmlWindow::LoadFile.
@beginStyleTable
@style{wxHW_SCROLLBAR_NEVER}:
Never display scrollbars, not even when the page is larger than the
@@ -32,10 +32,10 @@
@style{wxHW_NO_SELECTION}:
Don't allow the user to select text.
@endStyleTable
@library{wxhtml}
@category{html}
@seealso
wxHtmlLinkEvent, wxHtmlCellEvent
*/
@@ -47,15 +47,15 @@ public:
Constructor. The parameters are the same as for the wxScrolledWindow
constructor.
@param style
@param style
Window style. See wxHtmlWindow.
*/
wxHtmlWindow();
wxHtmlWindow(wxWindow parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHW_DEFAULT_STYLE,
const wxString& name = "htmlWindow");
wxHtmlWindow(wxWindow parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxHW_DEFAULT_STYLE,
const wxString& name = "htmlWindow");
//@}
/**
@@ -69,9 +69,9 @@ public:
static void AddFilter(wxHtmlFilter filter);
/**
Appends HTML fragment to currently displayed text and refreshes the window.
Appends HTML fragment to currently displayed text and refreshes the window.
@param source
@param source
HTML code fragment
@returns @false if an error occurred, @true otherwise.
@@ -81,14 +81,14 @@ public:
/**
Returns pointer to the top-level container.
See also: @ref overview_cells "Cells Overview",
See also: @ref overview_cells "Cells Overview",
@ref overview_printing "Printing Overview"
*/
wxHtmlContainerCell* GetInternalRepresentation();
/**
Returns anchor within currently opened page
(see wxHtmlWindow::GetOpenedPage).
(see wxHtmlWindow::GetOpenedPage).
If no page is opened or if the displayed page wasn't
produced by call to LoadPage, empty string is returned.
*/
@@ -113,7 +113,7 @@ public:
wxFrame* GetRelatedFrame();
/**
Moves back to the previous page. (each page displayed using
Moves back to the previous page. (each page displayed using
LoadPage() is stored in history list.)
*/
bool HistoryBack();
@@ -150,10 +150,10 @@ public:
virtual bool LoadFile(const wxFileName& filename);
/**
Unlike SetPage this function first loads HTML page from @e location
Unlike SetPage this function first loads HTML page from @e location
and then displays it. See example:
@param location
@param location
The address of document. See wxFileSystem for details on address format and
behaviour of "opener".
@@ -173,14 +173,14 @@ public:
Overloading this method is deprecated; intercept the event instead.
@param cell
@param cell
The cell inside which the mouse was clicked, always a simple
(i.e. non-container) cell
@param x, y
@param x, y
The logical coordinates of the click point
@param event
@param event
The mouse event containing other information about the click
@returns @true if a link was clicked, @false otherwise.
@@ -193,11 +193,11 @@ public:
Default behaviour is to emit a wxHtmlCellEvent.
Overloading this method is deprecated; intercept the event instead.
@param cell
@param cell
The cell inside which the mouse is currently, always a simple
(i.e. non-container) cell
@param x, y
@param x, y
The logical coordinates of the click point
*/
virtual void OnCellMouseHover(wxHtmlCell cell, wxCoord x,
@@ -215,14 +215,14 @@ public:
/**
Called when an URL is being opened (either when the user clicks on a link or
an image is loaded). The URL will be opened only if OnOpeningURL returns
an image is loaded). The URL will be opened only if OnOpeningURL returns
@c wxHTML_OPEN. This method is called by
wxHtmlParser::OpenURL.
You can override OnOpeningURL to selectively block some
URLs (e.g. for security reasons) or to redirect them elsewhere. Default
behaviour is to always return @c wxHTML_OPEN.
@param type
@param type
Indicates type of the resource. Is one of
@@ -242,16 +242,16 @@ public:
Opening a resource that doesn't fall into
any other category.
@param url
@param url
URL being opened.
@param redirect
@param redirect
Pointer to wxString variable that must be filled with an
URL if OnOpeningURL returns wxHTML_REDIRECT.
*/
virtual wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
const wxString& url,
wxString * redirect);
const wxString& url,
wxString * redirect);
/**
Called on parsing @c TITLE tag.
@@ -265,10 +265,10 @@ public:
Read values: all things set by SetFonts, SetBorders.
@param cfg
@param cfg
wxConfig from which you want to read the configuration.
@param path
@param path
Optional path in config tree. If not given current path is used.
*/
virtual void ReadCustomization(wxConfigBase cfg,
@@ -311,7 +311,7 @@ public:
This function sets the space between border of window and HTML contents. See
image:
@param b
@param b
indentation from borders in pixels
*/
void SetBorders(int b);
@@ -319,16 +319,16 @@ public:
/**
This function sets font sizes and faces.
@param normal_face
This is face name for normal (i.e. non-fixed) font.
@param normal_face
This is face name for normal (i.e. non-fixed) font.
It can be either empty string (then the default face is chosen) or
platform-specific face name. Examples are "helvetica" under Unix or
"Times New Roman" under Windows.
@param fixed_face
@param fixed_face
The same thing for fixed face ( TT../TT )
@param sizes
@param sizes
This is an array of 7 items of int type.
The values represent size of font with HTML size from -2 to +4
( FONT SIZE=-2 to FONT SIZE=+4 ). Default sizes are used if sizes
@@ -341,10 +341,10 @@ public:
/**
Sets HTML page and display it. This won't @b load the page!!
It will display the @e source. See example:
If you want to load a document from some location use
If you want to load a document from some location use
LoadPage() instead.
@param source
@param source
The HTML document source to be displayed.
@returns @false if an error occurred, @true otherwise.
@@ -363,7 +363,7 @@ public:
this sets statusbar slot where messages will be displayed.
(Default is -1 = no messages.)
@param bar
@param bar
statusbar slot number (0..n)
*/
void SetRelatedStatusBar(int bar);
@@ -376,15 +376,15 @@ public:
/**
Saves custom settings into wxConfig. It uses the path 'path'
if given, otherwise it saves info into currently selected path.
Regardless of whether the path is given or not, the function creates sub-path
Regardless of whether the path is given or not, the function creates sub-path
@c wxHtmlWindow.
Saved values: all things set by SetFonts, SetBorders.
@param cfg
@param cfg
wxConfig to which you want to save the configuration.
@param path
@param path
Optional path in config tree. If not given, the current path is used.
*/
virtual void WriteCustomization(wxConfigBase cfg,
@@ -395,9 +395,9 @@ public:
/**
@class wxHtmlLinkEvent
@headerfile htmlwin.h wx/html/htmlwin.h
This event class is used for the events generated by wxHtmlWindow.
@library{wxhtml}
@category{FIXME}
*/
@@ -420,9 +420,9 @@ public:
/**
@class wxHtmlCellEvent
@headerfile htmlwin.h wx/html/htmlwin.h
This event class is used for the events generated by wxHtmlWindow.
@library{wxhtml}
@category{FIXME}
*/

76
interface/html/htmprint.h
View File

@@ -9,12 +9,12 @@
/**
@class wxHtmlDCRenderer
@headerfile htmprint.h wx/html/htmprint.h
This class can render HTML document into a specified area of a DC. You can use
it
in your own printing code, although use of wxHtmlEasyPrinting
in your own printing code, although use of wxHtmlEasyPrinting
or wxHtmlPrintout is strongly recommended.
@library{wxhtml}
@category{FIXME}
*/
@@ -38,13 +38,13 @@ public:
/**
Renders HTML text to the DC.
@param x,y
@param x,y
position of upper-left corner of printing rectangle (see SetSize)
@param from
@param from
y-coordinate of the very first visible cell
@param dont_render
@param dont_render
if @true then this method only returns y coordinate of the next page
and does not output anything
*/
@@ -72,17 +72,17 @@ public:
const int sizes = @NULL);
/**
Assign text to the renderer. Render() then draws
Assign text to the renderer. Render() then draws
the text onto DC.
@param html
@param html
HTML text. This is not a filename.
@param basepath
@param basepath
base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.
@param isdir
@param isdir
@false if basepath is filename, @true if it is directory name
(see wxFileSystem for detailed explanation)
*/
@@ -102,11 +102,11 @@ public:
/**
@class wxHtmlEasyPrinting
@headerfile htmprint.h wx/html/htmprint.h
This class provides very simple interface to printing
This class provides very simple interface to printing
architecture. It allows you to print HTML documents using
only a few commands.
only a few commands.
@library{wxhtml}
@category{html}
*/
@@ -116,10 +116,10 @@ public:
/**
Constructor.
@param name
@param name
Name of the printing object. Used by preview frames and setup dialogs.
@param parentWindow
@param parentWindow
pointer to the window that will own the preview frame and setup dialogs. May be
@NULL.
*/
@@ -127,7 +127,7 @@ public:
wxWindow* parentWindow = @NULL);
/**
Returns a pointer to wxPageSetupDialogData instance used by
Returns a pointer to wxPageSetupDialogData instance used by
this class. You can set its parameters (via SetXXXX methods).
*/
wxPageSetupDialogData* GetPageSetupData();
@@ -149,7 +149,7 @@ public:
void PageSetup();
/**
Preview HTML file.
Preview HTML file.
Returns @false in case of error -- call
wxPrinter::GetLastError to get detailed
@@ -158,16 +158,16 @@ public:
bool PreviewFile(const wxString& htmlfile);
/**
Preview HTML text (not file!).
Preview HTML text (not file!).
Returns @false in case of error -- call
wxPrinter::GetLastError to get detailed
information about the kind of the error.
@param htmltext
@param htmltext
HTML text.
@param basepath
@param basepath
base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.
*/
@@ -184,16 +184,16 @@ public:
bool PrintFile(const wxString& htmlfile);
/**
Print HTML text (not file!).
Print HTML text (not file!).
Returns @false in case of error -- call
wxPrinter::GetLastError to get detailed
information about the kind of the error.
@param htmltext
@param htmltext
HTML text.
@param basepath
@param basepath
base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.
*/
@@ -217,10 +217,10 @@ public:
@TIME@ is replaced by the current time in default format
@TITLE@ is replaced with the title of the document
@param footer
@param footer
HTML text to be used as footer.
@param pg
@param pg
one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
*/
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
@@ -234,10 +234,10 @@ public:
@TIME@ is replaced by the current time in default format
@TITLE@ is replaced with the title of the document
@param header
@param header
HTML text to be used as header.
@param pg
@param pg
one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
*/
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
@@ -252,9 +252,9 @@ public:
/**
@class wxHtmlPrintout
@headerfile htmprint.h wx/html/htmprint.h
This class serves as printout class for HTML documents.
@library{wxhtml}
@category{html}
*/
@@ -290,10 +290,10 @@ public:
@TIME@ is replaced by the current time in default format
@TITLE@ is replaced with the title of the document
@param footer
@param footer
HTML text to be used as footer.
@param pg
@param pg
one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
*/
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
@@ -307,16 +307,16 @@ public:
@TIME@ is replaced by the current time in default format
@TITLE@ is replaced with the title of the document
@param header
@param header
HTML text to be used as header.
@param pg
@param pg
one of wxPAGE_ODD, wxPAGE_EVEN and wxPAGE_ALL constants.
*/
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
/**
Prepare the class for printing this HTML @b file. The file may be located on
Prepare the class for printing this HTML @b file. The file may be located on
any virtual file system or it may be normal file.
*/
void SetHtmlFile(const wxString& htmlfile);
@@ -324,14 +324,14 @@ public:
/**
Prepare the class for printing this HTML text.
@param html
@param html
HTML text. (NOT file!)
@param basepath
@param basepath
base directory (html string would be stored there if it was in
file). It is used to determine path for loading images, for example.
@param isdir
@param isdir
@false if basepath is filename, @true if it is directory name
(see wxFileSystem for detailed explanation)
*/

44
interface/html/winpars.h
View File

@@ -9,14 +9,14 @@
/**
@class wxHtmlTagsModule
@headerfile winpars.h wx/html/winpars.h
This class provides easy way of filling wxHtmlWinParser's table of
tag handlers. It is used almost exclusively together with the set of
@ref overview_handlers "TAGS_MODULE_* macros"
@library{wxhtml}
@category{FIXME}
@seealso
@ref overview_handlers "Tag Handlers", wxHtmlTagHandler, wxHtmlWinTagHandler,
*/
@@ -28,7 +28,7 @@ public:
only of lines of the following type:
I recommend using the @b TAGS_MODULE_* macros.
@param parser
@param parser
Pointer to the parser that requested tables filling.
*/
virtual void FillHandlersTable(wxHtmlWinParser parser);
@@ -38,12 +38,12 @@ public:
/**
@class wxHtmlWinTagHandler
@headerfile winpars.h wx/html/winpars.h
This is basically wxHtmlTagHandler except that
it is extended with protected member m_WParser pointing to
the wxHtmlWinParser object (value of this member is identical
to wxHtmlParser's m_Parser).
@library{wxhtml}
@category{html}
*/
@@ -63,15 +63,15 @@ public:
/**
@class wxHtmlWinParser
@headerfile winpars.h wx/html/winpars.h
This class is derived from wxHtmlParser and
its main goal is to parse HTML input so that it can be displayed in
wxHtmlWindow. It uses a special
wxHtmlWindow. It uses a special
wxHtmlWinTagHandler.
@library{wxhtml}
@category{html}
@seealso
@ref overview_handlers "Handlers overview"
*/
@@ -86,7 +86,7 @@ public:
window such as wxHtmlListBox).
*/
wxHtmlWinParser();
wxHtmlWinParser(wxHtmlWindowInterface wndIface);
wxHtmlWinParser(wxHtmlWindowInterface wndIface);
//@}
/**
@@ -101,11 +101,11 @@ public:
wxHtmlContainerCell* CloseContainer();
/**
Creates font based on current setting (see
SetFontSize(),
SetFontBold(),
SetFontItalic(),
SetFontFixed(),
Creates font based on current setting (see
SetFontSize(),
SetFontBold(),
SetFontItalic(),
SetFontFixed(),
wxHtmlWinParser::SetFontUnderlined)
and returns pointer to it.
If the font was already created only a pointer is returned.
@@ -153,7 +153,7 @@ public:
/**
Returns wxEncodingConverter class used
to do conversion between @ref getinputencoding() "input encoding"
to do conversion between @ref getinputencoding() "input encoding"
and @ref getoutputencoding() "output encoding".
*/
wxEncodingConverter * GetEncodingConverter();
@@ -194,7 +194,7 @@ public:
wxFontEncoding GetInputEncoding();
/**
Returns actual hypertext link. (This value has a non-empty
Returns actual hypertext link. (This value has a non-empty
@ref wxHtmlLinkInfo::gethref Href string
if the parser is between @c A and @c /A tags,
wxEmptyString otherwise.)
@@ -231,7 +231,7 @@ public:
void SetActualColor(const wxColour& clr);
/**
Sets default horizontal alignment (see
Sets default horizontal alignment (see
wxHtmlContainerCell::SetAlignHor.)
Alignment of newly opened container is set to this value.
*/
@@ -246,8 +246,8 @@ public:
/**
Sets the DC. This must be called before wxHtmlParser::Parse!
@e pixel_scale can be used when rendering to high-resolution
DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
@e pixel_scale can be used when rendering to high-resolution
DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
*/
@@ -260,7 +260,7 @@ public:
/**
Sets current font face to @e face. This affects either fixed size
font or proportional, depending on context (whether the parser is
font or proportional, depending on context (whether the parser is
inside @c TT tag or not).
*/
void SetFontFace(const wxString& face);