diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 25eb6181c1..c4d472c679 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -28,6 +28,25 @@ wxObject Constructor. +\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler} + +\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}} + +This static function adds new handler into the list of handlers. +The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS. + +\wxheading{Note} + +You can call: + +\begin{verbatim} +wxFileSystem::AddHandler(new My_FS_Handler); +\end{verbatim} + +This is because (a) AddHandler is a static method, and (b) the handlers +are deleted in wxFileSystem's destructor so that you don't have to +care about it. + \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto} \func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}} @@ -75,22 +94,3 @@ or NULL if failed. It first tries to open the file in relative scope (based on value passed to ChangePathTo() method) and then as an absolute path. -\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler} - -\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}} - -This static function adds new handler into the list of handlers. -The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS. - -\wxheading{Note} - -You can call: - -\begin{verbatim} -wxFileSystem::AddHandler(new My_FS_Handler); -\end{verbatim} - -This is because (a) AddHandler is a static method, and (b) the handlers -are deleted in wxFileSystem's destructor so that you don't have to -care about it. - diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index 80a02a6edb..1bc8655257 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -60,6 +60,50 @@ bool MyHand::CanOpen(const wxString& location) Must be overwriten in derived handlers. +\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor} + +\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}} + +Returns anchor if present in the location. +See \helpref{wxFSFile}{wxfsfilegetanchor} for details. + +Example : GetAnchor("index.htm\#chapter2") == "chapter2" + +{\bf Note:} anchor is NOT part of left location. + +\membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation} + +\constfunc{wxString}{GetLeftLocation}{\param{const wxString\& }{location}} + +Returns left location string extracted from {\it location}. + +Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip" + +\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext} + +\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}} + +Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType +returns real MIME type - either extension-based or queried from HTTP) + +Example : GetMimeTypeFromExt("index.htm") == "text/html" + +\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol} + +\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}} + +Returns protocol string extracted from {\it location}. + +Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip" + +\membersection{wxFileSystemHandler::GetRightLocation}\label{wxfilesystemhandlergetrightlocation} + +\constfunc{wxString}{GetRightLocation}{\param{const wxString\& }{location}} + +Returns right location string extracted from {\it location}. + +Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm" + \membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile} \func{virtual wxFSFile*}{OpenFile}{\param{wxFileSystem\& }{fs}, \param{const wxString\& }{location}} @@ -75,47 +119,3 @@ for details how to use it.} \docparam{location}{The {\bf absolute} location of file.} -\membersection{wxFileSystemHandler::GetProtocol}\label{wxfilesystemhandlergetprotocol} - -\constfunc{wxString}{GetProtocol}{\param{const wxString\& }{location}} - -Returns protocol string extracted from {\it location}. - -Example: GetProtocol("file:myzipfile.zip\#zip:index.htm") == "zip" - -\membersection{wxFileSystemHandler::GetLeftLocation}\label{wxfilesystemhandlergetleftlocation} - -\constfunc{wxString}{GetLeftLocation}{\param{const wxString\& }{location}} - -Returns left location string extracted from {\it location}. - -Example: GetLeftLocation("file:myzipfile.zip\#zip:index.htm") == "file:myzipfile.zip" - -\membersection{wxFileSystemHandler::GetAnchor}\label{wxfilesystemhandlergetanchor} - -\constfunc{wxString}{GetAnchor}{\param{const wxString\& }{location}} - -Returns anchor if present in the location. -See \helpref{wxFSFile}{wxfsfilegetanchor} for details. - -Example : GetAnchor("index.htm\#chapter2") == "chapter2" - -{\bf Note:} anchor is NOT part of left location. - -\membersection{wxFileSystemHandler::GetRightLocation}\label{wxfilesystemhandlergetrightlocation} - -\constfunc{wxString}{GetRightLocation}{\param{const wxString\& }{location}} - -Returns right location string extracted from {\it location}. - -Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm" - -\membersection{wxFileSystemHandler::GetMimeTypeFromExt}\label{wxfilesystemhandlergetmimetypefromext} - -\func{wxString}{GetMimeTypeFromExt}{\param{const wxString\& }{location}} - -Returns MIME type based on {\bf extension} of {\it location}. (While wxFSFile::GetMimeType -returns real MIME type - either extension-based or queried from HTTP) - -Example : GetMimeTypeFromExt("index.htm") == "text/html" - diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 7c0e956aa1..14b54ccd7d 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -67,39 +67,6 @@ class wxMyFSFile : public wxFSFile }; \end{verbatim} -\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream} - -\constfunc{wxInputStream*}{GetStream}{\void} - -Returns pointer to the stream. You can use the returned -stream to directly access data. You may suppose -that the stream provide Seek and GetSize functionality -(even in case of HTTP protocol which doesn't provide -this by default. wxHtml is using local cache to workaround -this and to speed up connection) - -\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype} - -\constfunc{const wxString\&}{GetMimeType}{\void} - -Returns MIME type of the content of this file. It is either -extension-based (see wxMimeTypesManager) or extracted from -HTTP protocol Content-Type header. - -\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation} - -\constfunc{const wxString\&}{GetLocation}{\void} - -Returns full location of the file, including path and protocol. -Examples : - -\begin{verbatim} -http://www.wxwindows.org -http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt -file:/home/vasek/index.htm -relative-file.htm -\end{verbatim} - \membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor} \constfunc{const wxString\&}{GetAnchor}{\void} @@ -119,3 +86,36 @@ But it may have some meaning with other files (for example myanim.avi\#200 may refer to position in animation or reality.wrl\#MyView may refer to predefined view in VRML) +\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation} + +\constfunc{const wxString\&}{GetLocation}{\void} + +Returns full location of the file, including path and protocol. +Examples : + +\begin{verbatim} +http://www.wxwindows.org +http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt +file:/home/vasek/index.htm +relative-file.htm +\end{verbatim} + +\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype} + +\constfunc{const wxString\&}{GetMimeType}{\void} + +Returns MIME type of the content of this file. It is either +extension-based (see wxMimeTypesManager) or extracted from +HTTP protocol Content-Type header. + +\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream} + +\constfunc{wxInputStream*}{GetStream}{\void} + +Returns pointer to the stream. You can use the returned +stream to directly access data. You may suppose +that the stream provide Seek and GetSize functionality +(even in case of HTTP protocol which doesn't provide +this by default. wxHtml is using local cache to workaround +this and to speed up connection) + diff --git a/docs/latex/wx/htcell.tex b/docs/latex/wx/htcell.tex index 1774f94f8f..311186ecbf 100644 --- a/docs/latex/wx/htcell.tex +++ b/docs/latex/wx/htcell.tex @@ -49,112 +49,6 @@ Usage : while (container->AdjustPagebreak(&p)) {} \end{verbatim} -\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent} - -\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}} - -Sets parent container of this cell. This is called from -\helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}. - -\membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent} - -\constfunc{wxHtmlContainerCell*}{GetParent}{\void} - -Returns pointer to parent container. - -\membersection{wxHtmlCell::GetPosX}\label{wxhtmlcellgetposx} - -\constfunc{int}{GetPosX}{\void} - -Returns X position within parent (the value is relative to parent's -upper left corner). The returned value is meaningful only if -parent's \helpref{Layout}{wxhtmlcelllayout} was called before! - -\membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy} - -\constfunc{int}{GetPosY}{\void} - -Returns Y position within parent (the value is relative to parent's -upper left corner). The returned value is meaningful only if -parent's \helpref{Layout}{wxhtmlcelllayout} was called before! - -\membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth} - -\constfunc{int}{GetWidth}{\void} - -Returns width of the cell (m_Width member). - -\membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight} - -\constfunc{int}{GetHeight}{\void} - -Returns height of the cell (m_Height member). - -\membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent} - -\constfunc{int}{GetDescent}{\void} - -Returns descent value of the cell (m_Descent member). See explanation: - -\image{}{descent.bmp} - -\membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink} - -\constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}} - -Returns hypertext link if associated with this cell or empty string otherwise. -(Note : this makes sense only for visible tags). - -\wxheading{Parameters} - -\docparam{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)} - -\membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext} - -\constfunc{wxHtmlCell*}{GetNext}{\void} - -Returns pointer to the next cell in list (see htmlcell.h if you're -interested in details). - -\membersection{wxHtmlCell::SetPos}\label{wxhtmlcellsetpos} - -\func{void}{SetPos}{\param{int }{x}, \param{int }{y}} - -Sets cell's position within parent container. - -\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink} - -\func{void}{SetLink}{\param{const wxString\& }{link}} - -Sets the hypertext link asocciated with this cell. (Default value -is wxEmptyString (no link)) - -\membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext} - -\func{void}{SetNext}{\param{wxHtmlCell }{*cell}} - -Sets the next cell in the list. This shouldn't be called by user - it is -to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell} - -\membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout} - -\func{virtual void}{Layout}{\param{int }{w}} - -This method performs 2 actions: - -\begin{enumerate} -\item adjusts cell's width according to the fact that maximal possible width is {\it w}. -(this has sense when working with horizontal lines, tables etc.) -\item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members) -based on actual width {\it w} -\end{enumerate} - -It must be called before displaying cells structure because -m\_PosX and m\_PosY are undefined (or invalid) -before calling Layout. - \membersection{wxHtmlCell::Draw}\label{wxhtmlcelldraw} \func{virtual void}{Draw}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{view\_y1}, \param{int }{view\_y2}} @@ -220,6 +114,85 @@ HTML_COND_ISANCHOR condition) from this number} \end{twocollist} +\membersection{wxHtmlCell::GetDescent}\label{wxhtmlcellgetdescent} + +\constfunc{int}{GetDescent}{\void} + +Returns descent value of the cell (m_Descent member). See explanation: + +\image{}{descent.bmp} + +\membersection{wxHtmlCell::GetHeight}\label{wxhtmlcellgetheight} + +\constfunc{int}{GetHeight}{\void} + +Returns height of the cell (m_Height member). + +\membersection{wxHtmlCell::GetLink}\label{wxhtmlcellgetlink} + +\constfunc{virtual wxString}{GetLink}{\param{int }{x = 0}, \param{int }{y = 0}} + +Returns hypertext link if associated with this cell or empty string otherwise. +(Note : this makes sense only for visible tags). + +\wxheading{Parameters} + +\docparam{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)} + +\membersection{wxHtmlCell::GetNext}\label{wxhtmlcellgetnext} + +\constfunc{wxHtmlCell*}{GetNext}{\void} + +Returns pointer to the next cell in list (see htmlcell.h if you're +interested in details). + +\membersection{wxHtmlCell::GetParent}\label{wxhtmlcellgetparent} + +\constfunc{wxHtmlContainerCell*}{GetParent}{\void} + +Returns pointer to parent container. + +\membersection{wxHtmlCell::GetPosX}\label{wxhtmlcellgetposx} + +\constfunc{int}{GetPosX}{\void} + +Returns X position within parent (the value is relative to parent's +upper left corner). The returned value is meaningful only if +parent's \helpref{Layout}{wxhtmlcelllayout} was called before! + +\membersection{wxHtmlCell::GetPosY}\label{wxhtmlcellgetposy} + +\constfunc{int}{GetPosY}{\void} + +Returns Y position within parent (the value is relative to parent's +upper left corner). The returned value is meaningful only if +parent's \helpref{Layout}{wxhtmlcelllayout} was called before! + +\membersection{wxHtmlCell::GetWidth}\label{wxhtmlcellgetwidth} + +\constfunc{int}{GetWidth}{\void} + +Returns width of the cell (m_Width member). + +\membersection{wxHtmlCell::Layout}\label{wxhtmlcelllayout} + +\func{virtual void}{Layout}{\param{int }{w}} + +This method performs 2 actions: + +\begin{enumerate} +\item adjusts cell's width according to the fact that maximal possible width is {\it w}. +(this has sense when working with horizontal lines, tables etc.) +\item prepares layout (=fill-in m\_PosX, m\_PosY (and sometimes m\_Height) members) +based on actual width {\it w} +\end{enumerate} + +It must be called before displaying cells structure because +m\_PosX and m\_PosY are undefined (or invalid) +before calling Layout. + \membersection{wxHtmlCell::OnMouseClick}\label{wxhtmlcellonmouseclick} \func{virtual void}{OnMouseClick}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{bool }{left}, \param{bool }{middle}, \param{bool }{right}} @@ -242,3 +215,30 @@ key events or whatsoever) you should use wxHtmlBinderCell instead. \docparam{left, middle, right}{boolean flags for mouse buttons. TRUE if the left/middle/right button is pressed, FALSE otherwise} +\membersection{wxHtmlCell::SetLink}\label{wxhtmlcellsetlink} + +\func{void}{SetLink}{\param{const wxString\& }{link}} + +Sets the hypertext link asocciated with this cell. (Default value +is wxEmptyString (no link)) + +\membersection{wxHtmlCell::SetNext}\label{wxhtmlcellsetnext} + +\func{void}{SetNext}{\param{wxHtmlCell }{*cell}} + +Sets the next cell in the list. This shouldn't be called by user - it is +to be used only by \helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell} + +\membersection{wxHtmlCell::SetParent}\label{wxhtmlcellsetparent} + +\func{void}{SetParent}{\param{wxHtmlContainerCell }{*p}} + +Sets parent container of this cell. This is called from +\helpref{wxHtmlContainerCell::InsertCell}{wxhtmlcontainercellinsertcell}. + +\membersection{wxHtmlCell::SetPos}\label{wxhtmlcellsetpos} + +\func{void}{SetPos}{\param{int }{x}, \param{int }{y}} + +Sets cell's position within parent container. + diff --git a/docs/latex/wx/htcontnr.tex b/docs/latex/wx/htcontnr.tex index dbc690ebb3..53cd3171c6 100644 --- a/docs/latex/wx/htcontnr.tex +++ b/docs/latex/wx/htcontnr.tex @@ -25,12 +25,73 @@ contain more cells in it. It is heavily used in the wxHTML layout algorithm. Constructor. {\it parent} is pointer to parent container or NULL. +\membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor} + +\constfunc{int}{GetAlignHor}{\void} + +Returns container's horizontal alignment. + +\membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver} + +\constfunc{int}{GetAlignVer}{\void} + +Returns container's vertical alignment. + +\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell} + +\func{wxHtmlCell*}{GetFirstCell}{\void} + +Returns pointer to the first cell in the list. +You can then use wxHtmlCell's GetNext method to obtain pointer to the next +cell in list. + +{\bf Note} : This shouldn't be used by the end user. If you need some way of +finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method +instead. + +\membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent} + +\constfunc{int}{GetIndent}{\param{int }{ind}} + +Returns the indentation. {\it ind} is one of the {\bf HTML\_INDENT\_*} constants. + +{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits} +with same {\it ind} parameter in order to correctly interpret the returned integer value. +It is NOT always in pixels! + +\membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits} + +\constfunc{int}{GetIndentUnits}{\param{int }{ind}} + +Returns units of intentation value for {\it ind} where {\it ind} is one +of the {\bf HTML\_INDENT\_*} constants. + + +\membersection{wxHtmlContainerCell::GetMaxLineWidth}\label{wxhtmlcontainercellgetmaxlinewidth} + +\constfunc{int}{GetMaxLineWidth}{\void} + +Returns width of widest line (note : this may be more than GetWidth()!! +E.g. if you have 640x480 image and the wxHtmlWindow is only 100x100...) + +Call to this method is valid only after calling \helpref{Layout}{wxhtmlcelllayout} + \membersection{wxHtmlContainerCell::InsertCell}\label{wxhtmlcontainercellinsertcell} \func{void}{InsertCell}{\param{wxHtmlCell }{*cell}} Inserts new cell into the container. +\membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign} + +\func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}} + +Sets container's alignment (both horizontal and vertical) according to +the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact +it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor} +and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}. + + \membersection{wxHtmlContainerCell::SetAlignHor}\label{wxhtmlcontainercellsetalignhor} \func{void}{SetAlignHor}{\param{int }{al}} @@ -50,12 +111,6 @@ each line is aligned according to {\it al} value. } -\membersection{wxHtmlContainerCell::GetAlignHor}\label{wxhtmlcontainercellgetalignhor} - -\constfunc{int}{GetAlignHor}{\void} - -Returns container's horizontal alignment. - \membersection{wxHtmlContainerCell::SetAlignVer}\label{wxhtmlcontainercellsetalignver} \func{void}{SetAlignVer}{\param{int }{al}} @@ -75,11 +130,23 @@ Sets container's {\it vertical alignment}. This is per-line alignment! \image{}{alignv.bmp} } -\membersection{wxHtmlContainerCell::GetAlignVer}\label{wxhtmlcontainercellgetalignver} +\membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour} -\constfunc{int}{GetAlignVer}{\void} +\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}} -Returns container's vertical alignment. +Sets background color for this container. + +\membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder} + +\func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}} + +Sets border (frame) colours. Border is rectangle around the container. + +\wxheading{Parameters} + +\docparam{clr1}{Color of top and left lines} + +\docparam{clr2}{Color of bottom and right lines} \membersection{wxHtmlContainerCell::SetIndent}\label{wxhtmlcontainercellsetindent} @@ -116,33 +183,26 @@ of parent container} \end{twocollist} } -\membersection{wxHtmlContainerCell::GetIndent}\label{wxhtmlcontainercellgetindent} +\membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight} -\constfunc{int}{GetIndent}{\param{int }{ind}} +\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}} -Returns the indentation. {\it ind} is one of the {\bf HTML\_INDENT\_*} constants. +Sets minimal height of the container. -{\bf Note:} You must call \helpref{GetIndentUnits}{wxhtmlcontainercellgetindentunits} -with same {\it ind} parameter in order to correctly interpret the returned integer value. -It is NOT always in pixels! +(When container's \helpref{Layout}{wxhtmlcelllayout} is called, m_Height +is set depending on layout of subcells to the height of area covered +by layouted subcells. Call to this method guarantees you that the height +of container is never smaller than {\it h} - even if the subcells cover +much smaller area.) -\membersection{wxHtmlContainerCell::GetIndentUnits}\label{wxhtmlcontainercellgetindentunits} +\wxheading{Parameters} -\constfunc{int}{GetIndentUnits}{\param{int }{ind}} - -Returns units of intentation value for {\it ind} where {\it ind} is one -of the {\bf HTML\_INDENT\_*} constants. - - -\membersection{wxHtmlContainerCell::SetAlign}\label{wxhtmlcontainercellsetalign} - -\func{void}{SetAlign}{\param{const wxHtmlTag\& }{tag}} - -Sets container's alignment (both horizontal and vertical) according to -the values stored in {\it tag}. (Tags {\tt ALIGN} parameter is extracted.) In fact -it is only a front-end to \helpref{SetAlignHor}{wxhtmlcontainercellsetalignhor} -and \helpref{SetAlignVer}{wxhtmlcontainercellsetalignver}. +\docparam{h}{The minimal height.} +\docparam{align}{If height of the container is lower than min. height, empty space must be inserted +somewhere in order to ensure minimal height. This parameter is one of {\bf HTML_ALIGN_TOP, +HTML_ALIGN_BOTTOM, HTML_ALIGN_CENTER} constants. It refers to the {\it contents}, not to the +empty place!} \membersection{wxHtmlContainerCell::SetWidthFloat}\label{wxhtmlcontainercellsetwidthfloat} @@ -177,63 +237,3 @@ of parent container} info is extracted from tag's {\tt WIDTH} parameter.} -\membersection{wxHtmlContainerCell::SetMinHeight}\label{wxhtmlcontainercellsetminheight} - -\func{void}{SetMinHeight}{\param{int }{h}, \param{int }{align = HTML_ALIGN_TOP}} - -Sets minimal height of the container. - -(When container's \helpref{Layout}{wxhtmlcelllayout} is called, m_Height -is set depending on layout of subcells to the height of area covered -by layouted subcells. Call to this method guarantees you that the height -of container is never smaller than {\it h} - even if the subcells cover -much smaller area.) - -\wxheading{Parameters} - -\docparam{h}{The minimal height.} - -\docparam{align}{If height of the container is lower than min. height, empty space must be inserted -somewhere in order to ensure minimal height. This parameter is one of {\bf HTML_ALIGN_TOP, -HTML_ALIGN_BOTTOM, HTML_ALIGN_CENTER} constants. It refers to the {\it contents}, not to the -empty place!} - -\membersection{wxHtmlContainerCell::GetMaxLineWidth}\label{wxhtmlcontainercellgetmaxlinewidth} - -\constfunc{int}{GetMaxLineWidth}{\void} - -Returns width of widest line (note : this may be more than GetWidth()!! -E.g. if you have 640x480 image and the wxHtmlWindow is only 100x100...) - -Call to this method is valid only after calling \helpref{Layout}{wxhtmlcelllayout} - -\membersection{wxHtmlContainerCell::SetBackgroundColour}\label{wxhtmlcontainercellsetbackgroundcolour} - -\func{void}{SetBackgroundColour}{\param{const wxColour\& }{clr}} - -Sets background color for this container. - -\membersection{wxHtmlContainerCell::SetBorder}\label{wxhtmlcontainercellsetborder} - -\func{void}{SetBorder}{\param{const wxColour\& }{clr1}, \param{const wxColour\& }{clr2}} - -Sets border (frame) colours. Border is rectangle around the container. - -\wxheading{Parameters} - -\docparam{clr1}{Color of top and left lines} - -\docparam{clr2}{Color of bottom and right lines} - -\membersection{wxHtmlContainerCell::GetFirstCell}\label{wxhtmlcontainercellgetfirstcell} - -\func{wxHtmlCell*}{GetFirstCell}{\void} - -Returns pointer to the first cell in the list. -You can then use wxHtmlCell's GetNext method to obtain pointer to the next -cell in list. - -{\bf Note} : This shouldn't be used by the end user. If you need some way of -finding particular cell in the list, try \helpref{Find}{wxhtmlcellfind} method -instead. - diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 6acbc42042..01d37adc5c 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -40,22 +40,6 @@ wxEvtHandler Constructor. -\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat} - -\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} - -Sets format of title of the frame. Must contain exactly one "\%s" -(for title of displayed HTML page). - -\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir} - -\func{void}{SetTempDir}{\param{const wxString\& }{path}} - -Sets 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 NOT -deleted when program exits! - \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook} \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}} @@ -117,6 +101,28 @@ Returns TRUE if the keyword was found. IMPORTANT! KeywordSearch searches only pages listed in .htc file(s)! (you should have all pages in contents file...) +\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization} + +\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}} + +Reads controllers setting (position of window etc.) + +\membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir} + +\func{void}{SetTempDir}{\param{const wxString\& }{path}} + +Sets 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 NOT +deleted when program exits! + +\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat} + +\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} + +Sets format of title of the frame. Must contain exactly one "\%s" +(for title of displayed HTML page). + \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig} \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}} @@ -128,12 +134,6 @@ reads and writes settings (including wxHtmlWindow's settings) when needed. The only thing you must do is create wxConfig object and call UseConfig. -\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization} - -\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}} - -Reads controllers setting (position of window etc.) - \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization} \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}} diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex index 7d486f7170..9df02c7c11 100644 --- a/docs/latex/wx/htparser.tex +++ b/docs/latex/wx/htparser.tex @@ -40,76 +40,19 @@ wxObject Constructor. -\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs} +\membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag} -\func{void}{SetFS}{\param{wxFileSystem }{*fs}} +\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}} -Sets the virtual file system that will be used to request additional -files. (For example {\tt } tag handler requests wxFSFile with the -image data.) +This may (and may not) be overwriten in derived class. -\membersection{wxHtmlParser::GetFS}\label{wxhtmlparsergetfs} +This method is called each time new tag is about to be added. +{\it tag} contains information about the tag. (See \helpref{wxHtmlTag}{wxhtmltag} +for details.) -\constfunc{wxFileSystem*}{GetFS}{\void} - -Returns pointer to the file system. Because each tag handler has -reference to it's parent parser it can easily request the file by -calling - -\begin{verbatim} -wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg"); -\end{verbatim} - -\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse} - -\func{wxObject*}{Parse}{\param{const wxString\& }{source}} - -Proceeds parsing of the document. This is end-user method. You can simply -call it when you need to obtain parsed output (which is parser-specific) - -The method does these things: - -\begin{enumerate} -\item calls \helpref{InitParser(source)}{wxhtmlparserinitparser} -\item calls \helpref{DoParsing}{wxhtmlparserdoparsing} -\item calls \helpref{GetProduct}{wxhtmlparsergetproduct} -\item calls \helpref{DoneParser}{wxhtmlparserdoneparser} -\item returns value returned by GetProduct -\end{enumerate} - -You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly. - -\membersection{wxHtmlParser::InitParser}\label{wxhtmlparserinitparser} - -\func{virtual void}{InitParser}{\param{const wxString\& }{source}} - -Setups the parser for parsing the {\it source} string. (Should be overriden -in derived class) - -\membersection{wxHtmlParser::DoneParser}\label{wxhtmlparserdoneparser} - -\func{virtual void}{DoneParser}{\void} - -This must be called after DoParsing(). - -\membersection{wxHtmlParser::DoParsing}\label{wxhtmlparserdoparsing} - -\func{void}{DoParsing}{\param{int }{begin\_pos}, \param{int }{end\_pos}} - -\func{void}{DoParsing}{\void} - -Parses the m\_Source from begin\_pos to end\_pos-1. -(in noparams version it parses whole m\_Source) - -\membersection{wxHtmlParser::GetProduct}\label{wxhtmlparsergetproduct} - -\func{virtual wxObject*}{GetProduct}{\void} - -Returns product of parsing. Returned value is result of parsing -of the document. The type of this result depends on internal -representation in derived parser (but it must be derived from wxObject!). - -See wxHtmlWinParser for details. +Default (wxHtmlParser) behaviour is this: +First it finds a handler capable of handling this tag and then it calls +handler's HandleTag method. \membersection{wxHtmlParser::AddTagHandler}\label{wxhtmlparseraddtaghandler} @@ -125,6 +68,54 @@ by wxHtmlWinParser). All handlers are deleted on object deletion. +\membersection{wxHtmlParser::AddText}\label{wxhtmlparseraddword} + +\func{virtual void}{AddWord}{\param{const char* }{txt}} + +Must be overwriten in derived class. + +This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing} +each time a part of text is parsed. {\it txt} is NOT only one word, it is +substring of input. It is not formatted or preprocessed (so white spaces are +unmodified). + +\membersection{wxHtmlParser::DoParsing}\label{wxhtmlparserdoparsing} + +\func{void}{DoParsing}{\param{int }{begin\_pos}, \param{int }{end\_pos}} + +\func{void}{DoParsing}{\void} + +Parses the m\_Source from begin\_pos to end\_pos-1. +(in noparams version it parses whole m\_Source) + +\membersection{wxHtmlParser::DoneParser}\label{wxhtmlparserdoneparser} + +\func{virtual void}{DoneParser}{\void} + +This must be called after DoParsing(). + +\membersection{wxHtmlParser::GetFS}\label{wxhtmlparsergetfs} + +\constfunc{wxFileSystem*}{GetFS}{\void} + +Returns pointer to the file system. Because each tag handler has +reference to it's parent parser it can easily request the file by +calling + +\begin{verbatim} +wxFSFile *f = m_Parser -> GetFS() -> OpenFile("image.jpg"); +\end{verbatim} + +\membersection{wxHtmlParser::GetProduct}\label{wxhtmlparsergetproduct} + +\func{virtual wxObject*}{GetProduct}{\void} + +Returns product of parsing. Returned value is result of parsing +of the document. The type of this result depends on internal +representation in derived parser (but it must be derived from wxObject!). + +See wxHtmlWinParser for details. + \membersection{wxHtmlParser::GetSource}\label{wxhtmlparsergetsource} \func{wxString*}{GetSource}{\void} @@ -157,28 +148,37 @@ must exist as long as the window is displaying text. GetTempData() solves the problem. -\membersection{wxHtmlParser::AddText}\label{wxhtmlparseraddword} +\membersection{wxHtmlParser::InitParser}\label{wxhtmlparserinitparser} -\func{virtual void}{AddWord}{\param{const char* }{txt}} +\func{virtual void}{InitParser}{\param{const wxString\& }{source}} -Must be overwriten in derived class. +Setups the parser for parsing the {\it source} string. (Should be overriden +in derived class) -This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing} -each time a part of text is parsed. {\it txt} is NOT only one word, it is -substring of input. It is not formatted or preprocessed (so white spaces are -unmodified). +\membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse} -\membersection{wxHtmlParser::AddTag}\label{wxhtmlparseraddtag} +\func{wxObject*}{Parse}{\param{const wxString\& }{source}} -\func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}} +Proceeds parsing of the document. This is end-user method. You can simply +call it when you need to obtain parsed output (which is parser-specific) -This may (and may not) be overwriten in derived class. +The method does these things: -This method is called each time new tag is about to be added. -{\it tag} contains information about the tag. (See \helpref{wxHtmlTag}{wxhtmltag} -for details.) +\begin{enumerate} +\item calls \helpref{InitParser(source)}{wxhtmlparserinitparser} +\item calls \helpref{DoParsing}{wxhtmlparserdoparsing} +\item calls \helpref{GetProduct}{wxhtmlparsergetproduct} +\item calls \helpref{DoneParser}{wxhtmlparserdoneparser} +\item returns value returned by GetProduct +\end{enumerate} -Default (wxHtmlParser) behaviour is this: -First it finds a handler capable of handling this tag and then it calls -handler's HandleTag method. +You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly. + +\membersection{wxHtmlParser::SetFS}\label{wxhtmlparsersetfs} + +\func{void}{SetFS}{\param{wxFileSystem }{*fs}} + +Sets the virtual file system that will be used to request additional +files. (For example {\tt } tag handler requests wxFSFile with the +image data.) diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex index 04ce4fb345..12bacbb808 100644 --- a/docs/latex/wx/httag.tex +++ b/docs/latex/wx/httag.tex @@ -22,74 +22,6 @@ Constructor. You'll probably never have to construct wxHtmlTag object yourself. Feel free to ignore the constructor parameters... (have a look at lib/htmlparser.cpp if you're interested in creating it) -\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname} - -\constfunc{wxString}{GetName}{\void} - -Returns tag's name. The name is always in uppercase and it doesn't contain -'<' or '/' characters. (So the name of {\tt } tag is "FONT" -and name of {\tt } is "TABLE") - -\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam} - -\constfunc{bool}{HasParam}{\param{const wxString\& }{par}} - -Returns TRUE if the tag has parameter of the given name. -Example : {\tt } has two parameters named -"SIZE" and "COLOR". - -\wxheading{Parameters} - -\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!} - -\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam} - -\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}} - -Retuns the value of the parameter. You should check whether the -param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. - -\wxheading{Parameters} - -\docparam{par}{The parameter's name in uppercase} - -\docparam{with\_commas}{TRUE if you want to get commas as well. See example.} - -\wxheading{Example} - -\begin{verbatim} -... -/* you have wxHtmlTag variable tag which is equal to - HTML tag */ -dummy = tag.GetParam("SIZE"); - // dummy == "+2" -dummy = tag.GetParam("COLOR"); - // dummy == "#0000FF" -dummy = tag.GetParam("COLOR", TRUE); - // dummy == "\"#0000FF\"" -- see the difference!! -\end{verbatim} - -\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam} - -\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck} - -This method scans given parameter. Usage is exatly the same as sscanf's -usage except that you don't pass string but param name as the first parameter. - -\wxheading{Parameters} - -\docparam{par}{The name of tag you wanna query (in uppercase)} - -\docparam{format}{scanf()-like format string.} - -\wxheading{Cygwin and Mingw32} - -If you're using Cygwin beta 20 or Mingw32 compiler please remember -that ScanParam() is only partially implemented!! The problem is -that under Cygnus' GCC vsscanf() function is not implemented. I workarounded -this in a way which causes that you can use only one parameter in ... -(and only one \% in {\it format}) - \membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams} \constfunc{const wxString\&}{GetAllParams}{\void} @@ -99,35 +31,6 @@ Returns string with all params. Example : tag contains {\tt }. Call to tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}. -\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending} - -\constfunc{bool}{IsEnding}{\void} - -Returns TRUE if this tag is ending one. -({\tt } is ending tag, {\tt } is not) - - -\membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending} - -\constfunc{bool}{HasEnding}{\void} - -Returns TRUE if this tag is paired with ending tag, FALSE otherwise. - -See the example of HTML document: - -\begin{verbatim} - -Hello

-How are you? -

This is centered...

-Oops
Oooops! - -\end{verbatim} - -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. - \membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos} \constfunc{int}{GetBeginPos}{\void} @@ -167,3 +70,100 @@ bla bla bla bla bla intenal text bla bla ^ \end{verbatim} +\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname} + +\constfunc{wxString}{GetName}{\void} + +Returns tag's name. The name is always in uppercase and it doesn't contain +'<' or '/' characters. (So the name of {\tt } tag is "FONT" +and name of {\tt } is "TABLE") + +\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam} + +\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}} + +Retuns the value of the parameter. You should check whether the +param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. + +\wxheading{Parameters} + +\docparam{par}{The parameter's name in uppercase} + +\docparam{with\_commas}{TRUE if you want to get commas as well. See example.} + +\wxheading{Example} + +\begin{verbatim} +... +/* you have wxHtmlTag variable tag which is equal to + HTML tag */ +dummy = tag.GetParam("SIZE"); + // dummy == "+2" +dummy = tag.GetParam("COLOR"); + // dummy == "#0000FF" +dummy = tag.GetParam("COLOR", TRUE); + // dummy == "\"#0000FF\"" -- see the difference!! +\end{verbatim} + +\membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending} + +\constfunc{bool}{HasEnding}{\void} + +Returns TRUE if this tag is paired with ending tag, FALSE otherwise. + +See the example of HTML document: + +\begin{verbatim} + +Hello

+How are you? +

This is centered...

+Oops
Oooops! + +\end{verbatim} + +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. + +\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam} + +\constfunc{bool}{HasParam}{\param{const wxString\& }{par}} + +Returns TRUE if the tag has parameter of the given name. +Example : {\tt } has two parameters named +"SIZE" and "COLOR". + +\wxheading{Parameters} + +\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!} + +\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending} + +\constfunc{bool}{IsEnding}{\void} + +Returns TRUE if this tag is ending one. +({\tt } is ending tag, {\tt } is not) + + +\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam} + +\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck} + +This method scans given parameter. Usage is exatly the same as sscanf's +usage except that you don't pass string but param name as the first parameter. + +\wxheading{Parameters} + +\docparam{par}{The name of tag you wanna query (in uppercase)} + +\docparam{format}{scanf()-like format string.} + +\wxheading{Cygwin and Mingw32} + +If you're using Cygwin beta 20 or Mingw32 compiler please remember +that ScanParam() is only partially implemented!! The problem is +that under Cygnus' GCC vsscanf() function is not implemented. I workarounded +this in a way which causes that you can use only one parameter in ... +(and only one \% in {\it format}) + diff --git a/docs/latex/wx/httaghnd.tex b/docs/latex/wx/httaghnd.tex index 12e1a0cfb3..28877fb044 100644 --- a/docs/latex/wx/httaghnd.tex +++ b/docs/latex/wx/httaghnd.tex @@ -29,13 +29,6 @@ it can't be accessed by user but can be accessed from derived classes. Constructor. -\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser} - -\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}} - -Assigns {\it parser} to this handler. Each {\bf instance} of handler -is guaranteed to be called only from the parser. - \membersection{wxHtmlTagHandler::GetSupportedTags}\label{wxhtmltaghandlergetsupportedtags} \func{virtual wxString}{GetSupportedTags}{\void} @@ -85,3 +78,10 @@ for the string between this tag and paired ending tag: In this example, a call to ParseInner (with {\it tag} pointing to A tag) will parse 'Hello, world!'. +\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser} + +\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}} + +Assigns {\it parser} to this handler. Each {\bf instance} of handler +is guaranteed to be called only from the parser. + diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index 912719fa2f..361290ed33 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -41,27 +41,59 @@ Constructor. The parameters are same as in wxScrollWindow ctor. \docparam{style}{wxHW\_SCROLLBAR\_NEVER, or wxHW\_SCROLLBAR\_AUTO. Affects appearance of vertical scrollbar in the window.} -\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage} +\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter} -\func{bool}{SetPage}{\param{const wxString\& }{source}} +\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}} -Sets HTML page and display it. This won't {\bf load} the page!! -It will display the {\it source}. See example: +Adds \helpref{input filter}{filters} to the static list of available +filters. These filters are present by default: -\begin{verbatim} -htmlwin -> SetPage("Hello, world!"); -\end{verbatim} +\begin{itemize} +\item {\tt text/html} MIME type +\item {\tt image/*} MIME types +\item Plain Text filter (this filter is used if no other filter matches) +\end{itemize} -If you want to load document from some location use -\helpref{LoadPage}{wxhtmlwindowloadpage} instead. +\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} -\wxheading{Parameters} +\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void} -\docparam{source}{The HTML document source to be displayed.} +Returns pointer to the top-level container. -\wxheading{Return value} +See also: \helpref{Cells Overview}{cells}, +\helpref{Printing Overview}{printing} -FALSE if an error occured, TRUE otherwise +\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage} + +\func{wxString}{GetOpenedPage}{\void} + +Returns full location of the opened page. If no page is opened or if the displayed page wasn't +produced by call to LoadPage, empty string is returned. + +\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe} + +\constfunc{wxFrame*}{GetRelatedFrame}{\void} + +Returns the related frame. + +\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback} + +\func{bool}{HistoryBack}{\void} + +Moves back to the previous page. (each page displayed using +\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.) + +\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear} + +\func{void}{HistoryClear}{\void} + +Clears history. + +\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward} + +\func{bool}{HistoryForward}{\void} + +Moves to next page in history. \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage} @@ -82,38 +114,40 @@ htmlwin -> SetPage("help/myproject/index.htm"); FALSE if an error occured, TRUE otherwise -\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage} +\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} -\func{wxString}{GetOpenedPage}{\void} +\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}} -Returns full location of the opened page. If no page is opened or if the displayed page wasn't -produced by call to LoadPage, empty string is returned. +Called when user clicks on hypertext link. Default behaviour is to call +\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. -\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} +\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} -\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} +\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} -Sets frame in which page title will be displayed. {\it format} is format of -frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This -\%s is substituted with HTML page title. +This reads custom settings from wxConfig. It uses the path 'path' +if given, otherwise it saves info into currently selected path. +The values are stored in sub-path {\tt wxHtmlWindow} -\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe} - -\constfunc{wxFrame*}{GetRelatedFrame}{\void} - -Returns the related frame. - -\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} - -\func{void}{SetRelatedStatusBar}{\param{int }{bar}} - -{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe}, -this sets statusbar slot where messages will be displayed. -(Default is -1 = no messages.) +Read values : all things set by SetFonts, SetBorders. \wxheading{Parameters} -\docparam{bar}{statusbar slot number (0..n)} +\docparam{cfg}{wxConfig from which you wanna read configuration} + +\docparam{path}{Optional path in config tree. If not given current path is used.} + +\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} + +\func{void}{SetBorders}{\param{int }{b}} + +This function sets the space between border of window and HTML contents. See image: + +\image{}{border.bmp} + +\wxheading{Parameters} + +\docparam{b}{indentation from borders in pixels} \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts} @@ -159,33 +193,47 @@ Under Windows: Athough it seems different the fact is that the fonts are of approximately same size under both platforms (due to wxMSW / wxGTK inconsistency) -\membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} +\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage} -\func{void}{SetBorders}{\param{int }{b}} +\func{bool}{SetPage}{\param{const wxString\& }{source}} -This function sets the space between border of window and HTML contents. See image: +Sets HTML page and display it. This won't {\bf load} the page!! +It will display the {\it source}. See example: -\image{}{border.bmp} +\begin{verbatim} +htmlwin -> SetPage("Hello, world!"); +\end{verbatim} + +If you want to load document from some location use +\helpref{LoadPage}{wxhtmlwindowloadpage} instead. \wxheading{Parameters} -\docparam{b}{indentation from borders in pixels} +\docparam{source}{The HTML document source to be displayed.} -\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} +\wxheading{Return value} -\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} +FALSE if an error occured, TRUE otherwise -This reads custom settings from wxConfig. It uses the path 'path' -if given, otherwise it saves info into currently selected path. -The values are stored in sub-path {\tt wxHtmlWindow} +\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} -Read values : all things set by SetFonts, SetBorders. +\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} + +Sets frame in which page title will be displayed. {\it format} is format of +frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This +\%s is substituted with HTML page title. + +\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} + +\func{void}{SetRelatedStatusBar}{\param{int }{bar}} + +{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe}, +this sets statusbar slot where messages will be displayed. +(Default is -1 = no messages.) \wxheading{Parameters} -\docparam{cfg}{wxConfig from which you wanna read configuration} - -\docparam{path}{Optional path in config tree. If not given current path is used.} +\docparam{bar}{statusbar slot number (0..n)} \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization} @@ -205,51 +253,3 @@ Saved values : all things set by SetFonts, SetBorders. \docparam{path}{Optional path in config tree. If not given current path is used.} -\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} - -\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void} - -Returns pointer to the top-level container. - -See also: \helpref{Cells Overview}{cells}, -\helpref{Printing Overview}{printing} - -\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter} - -\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}} - -Adds \helpref{input filter}{filters} to the static list of available -filters. These filters are present by default: - -\begin{itemize} -\item {\tt text/html} MIME type -\item {\tt image/*} MIME types -\item Plain Text filter (this filter is used if no other filter matches) -\end{itemize} - -\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback} - -\func{bool}{HistoryBack}{\void} - -Moves back to the previous page. (each page displayed using -\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.) - -\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward} - -\func{bool}{HistoryForward}{\void} - -Moves to next page in history. - -\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear} - -\func{void}{HistoryClear}{\void} - -Clears history. - -\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} - -\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}} - -Called when user clicks on hypertext link. Default behaviour is to call -\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. - diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex index 6bb22d25c6..26c538b392 100644 --- a/docs/latex/wx/htwinprs.tex +++ b/docs/latex/wx/htwinprs.tex @@ -37,17 +37,47 @@ its mail goal is to parse HTML input so that it can be displayed in Constructor. Don't use the default one, use constructor with {\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow}) -\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc} +\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule} -\func{virtual void}{SetDC}{\param{wxDC }{*dc}} +\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}} -Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}! +Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler. -\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc} +\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer} -\func{wxDC*}{GetDC}{\void} +\func{wxHtmlContainerCell*}{CloseContainer}{\void} -Returns pointer to the DC used during parsing. +Closes the container, sets actual container to the parent one +and returns pointer to it (see \helpref{Overview}{cells}). + +\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont} + +\func{virtual wxFont*}{CreateCurrentFont}{\void} + +Creates font based on current setting (see +\helpref{SetFontSize}{wxhtmlwinparsersetfontsize}, +\helpref{SetFontBold}{wxhtmlwinparsersetfontbold}, +\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic}, +\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed}, +\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined}) +and returns pointer to it. +(If the font was already created only a pointer is returned.) + +Fonts created during parsing are temporary data and are not freed on DoneParser. +You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata} +to free the memory! + +\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor} + +\constfunc{const wxColour\&}{GetActualColor}{\void} + +Returns actual text color. + +\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign} + +\constfunc{int}{GetAlign}{\void} + +Returns default horizontal alignment. \membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight} @@ -67,27 +97,6 @@ Returns average char width in standard font. It's used as DC-independent metrics {\bf Note:} This function doesn't return {\it actual} width. If you wanna know height of current font, call {\tt GetDC -> GetCharWidth()} -\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow} - -\func{wxWindow*}{GetWindow}{\void} - -Returns associated window (wxHtmlWindow). This may be NULL! (You should always -test if it is non-NULL. For example {\tt TITLE} handler sets window -title only if some window is associated, otherwise it does nothing) - - -\membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts} - -\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}} - -Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} - -\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule} - -\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}} - -Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler. - \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer} \constfunc{wxHtmlContainerCell*}{GetContainer}{\void} @@ -99,39 +108,11 @@ Common use: m_WParser -> GetContainer() -> InsertCell(new ...); \end{verbatim} -\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer} +\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc} -\func{wxHtmlContainerCell*}{OpenContainer}{\void} +\func{wxDC*}{GetDC}{\void} -Opens new container and returns pointer to it (see \helpref{Overview}{cells}). - -% -%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer} -% -%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}} -% -%Allows you to directly set opened container. This is not recommended - you should use OpenContainer -%whereever possible. -% - -\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer} - -\func{wxHtmlContainerCell*}{CloseContainer}{\void} - -Closes the container, sets actual container to the parent one -and returns pointer to it (see \helpref{Overview}{cells}). - -\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize} - -\constfunc{int}{GetFontSize}{\void} - -Returns actual font size (HTML size varies from -2 to +4) - -\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} - -\func{void}{SetFontSize}{\param{int }{s}} - -Sets actual font size (HTML size varies from -2 to +4) +Returns pointer to the DC used during parsing. \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold} @@ -139,11 +120,11 @@ Sets actual font size (HTML size varies from -2 to +4) Returns TRUE if actual font is bold, FALSE otherwise. -\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold} +\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed} -\func{void}{SetFontBold}{\param{int }{x}} +\constfunc{int}{GetFontFixed}{\void} -Sets bold flag of actualfont. {\it x} is either TRUE of FALSE. +Returns TRUE if actual font is fixed face, FALSE otherwise. \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic} @@ -152,11 +133,11 @@ Sets bold flag of actualfont. {\it x} is either TRUE of FALSE. Returns TRUE if actual font is italic, FALSE otherwise. -\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic} +\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize} -\func{void}{SetFontItalic}{\param{int }{x}} +\constfunc{int}{GetFontSize}{\void} -Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. +Returns actual font size (HTML size varies from -2 to +4) \membersection{wxHtmlWinParser::GetFontUnderlined}\label{wxhtmlwinparsergetfontunderlined} @@ -164,62 +145,6 @@ Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. Returns TRUE if actual font is underlined, FALSE otherwise. -\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined} - -\func{void}{SetFontUnderlined}{\param{int }{x}} - -Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE. - -\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed} - -\constfunc{int}{GetFontFixed}{\void} - -Returns TRUE if actual font is fixed face, FALSE otherwise. - -\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed} - -\func{void}{SetFontFixed}{\param{int }{x}} - -Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE. - -\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign} - -\constfunc{int}{GetAlign}{\void} - -Returns default horizontal alignment. - -\membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign} - -\func{void}{SetAlign}{\param{int }{a}} - -Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}. -Alignment of newly opened container is set to this value. - -\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor} - -\constfunc{const wxColour\&}{GetLinkColor}{\void} - -Returns color of hypertext link text. - -\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor} - -\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}} - -Sets color of hypertext link. - -\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor} - -\constfunc{const wxColour\&}{GetActualColor}{\void} - -Returns actual text color. - -\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor} - -\func{void}{SetActualColor}{\param{const wxColour\& }{clr}} - -Sets actual text color. Note: this DOESN'T change the color! -You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself. - \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink} \constfunc{const wxString\&}{GetLink}{\void} @@ -229,26 +154,101 @@ if the parser is between {\tt } and {\tt } tags, wxEmptyString otherwise. +\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor} + +\constfunc{const wxColour\&}{GetLinkColor}{\void} + +Returns color of hypertext link text. + +\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow} + +\func{wxWindow*}{GetWindow}{\void} + +Returns associated window (wxHtmlWindow). This may be NULL! (You should always +test if it is non-NULL. For example {\tt TITLE} handler sets window +title only if some window is associated, otherwise it does nothing) + + +\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer} + +\func{wxHtmlContainerCell*}{OpenContainer}{\void} + +Opens new container and returns pointer to it (see \helpref{Overview}{cells}). + +% +\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor} + +\func{void}{SetActualColor}{\param{const wxColour\& }{clr}} + +Sets actual text color. Note: this DOESN'T change the color! +You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself. + +\membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign} + +\func{void}{SetAlign}{\param{int }{a}} + +Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}. +Alignment of newly opened container is set to this value. + +%\membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer} +% +%\func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}} +% +%Allows you to directly set opened container. This is not recommended - you should use OpenContainer +%whereever possible. +% + +\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc} + +\func{virtual void}{SetDC}{\param{wxDC }{*dc}} + +Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}! + +\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold} + +\func{void}{SetFontBold}{\param{int }{x}} + +Sets bold flag of actualfont. {\it x} is either TRUE of FALSE. + +\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed} + +\func{void}{SetFontFixed}{\param{int }{x}} + +Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE. + +\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic} + +\func{void}{SetFontItalic}{\param{int }{x}} + +Sets italic flag of actualfont. {\it x} is either TRUE of FALSE. + +\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize} + +\func{void}{SetFontSize}{\param{int }{s}} + +Sets actual font size (HTML size varies from -2 to +4) + +\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined} + +\func{void}{SetFontUnderlined}{\param{int }{x}} + +Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE. + +\membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts} + +\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}} + +Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} + \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink} \func{void}{SetLink}{\param{const wxString\& }{link}} Sets actual hypertext link. wxEmptyString means no link. -\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont} +\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor} -\func{virtual wxFont*}{CreateCurrentFont}{\void} +\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}} -Creates font based on current setting (see -\helpref{SetFontSize}{wxhtmlwinparsersetfontsize}, -\helpref{SetFontBold}{wxhtmlwinparsersetfontbold}, -\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic}, -\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed}, -\helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined}) -and returns pointer to it. -(If the font was already created only a pointer is returned.) - -Fonts created during parsing are temporary data and are not freed on DoneParser. -You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata} -to free the memory! +Sets color of hypertext link.