include/wx/html/winpars.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        winpars.h
   3 // Purpose:     wxHtmlWinParser class (parser to be used with wxHtmlWindow)
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows Licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef _WX_WINPARS_H_
  12 #define _WX_WINPARS_H_
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #if wxUSE_HTML
  20
  21 #include "wx/module.h"
  22 #include "wx/html/htmlpars.h"
  23 #include "wx/html/htmlcell.h"
  24
  25 class wxHtmlWinParser;
  26 class wxHtmlWinTagHandler;
  27 class wxHtmlTagsModule;
  28
  29 //--------------------------------------------------------------------------------
  30 // wxHtmlWinParser
  31 //                  This class is derived from wxHtmlParser and its mail goal
  32 //                  is to parse HTML input so that it can be displayed in
  33 //                  wxHtmlWindow. It uses special wxHtmlWinTagHandler.
  34 //--------------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxHtmlWinParser : public wxHtmlParser
  37 {
  38     friend class wxHtmlWindow;
  39
  40     public:
  41         wxHtmlWinParser(wxWindow *wnd = NULL);
  42
  43         virtual void InitParser(const wxString& source);
  44         virtual void DoneParser();
  45         virtual wxObject* GetProduct();
  46
  47         virtual void SetDC(wxDC *dc, double pixel_scale = 1.0) {m_DC = dc; m_PixelScale = pixel_scale;}
  48                 // Set's the DC used for parsing. If SetDC() is not called,
  49                 // parsing won't proceed
  50         wxDC *GetDC() {return m_DC;}
  51         double GetPixelScale() {return m_PixelScale;}
  52         int GetCharHeight() const {return m_CharHeight;}
  53         int GetCharWidth() const {return m_CharWidth;}
  54         // NOTE : these functions do _not_ return _actual_
  55         // height/width. They return h/w of default font
  56         // for this DC. If you want actual values, call
  57         // GetDC() -> GetChar...()
  58         wxWindow *GetWindow() {return m_Window;}
  59                 // returns associated wxWindow
  60
  61         void SetFonts(wxString normal_face, wxString fixed_face, const int *sizes);
  62                 // sets fonts to be used when displaying HTML page.
  63
  64         static void AddModule(wxHtmlTagsModule *module);
  65                 // Adds tags module. see wxHtmlTagsModule for details.
  66
  67         // parsing-related methods. These methods are called by tag handlers:
  68         wxHtmlContainerCell *GetContainer() const {return m_Container;}
  69             // Returns pointer to actual container. Common use in tag handler is :
  70             // m_WParser -> GetContainer() -> InsertCell(new ...);
  71         wxHtmlContainerCell *OpenContainer();
  72             // opens new container. This container is sub-container of opened
  73             // container. Sets GetContainer to newly created container
  74             // and returns it.
  75         wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
  76             // works like OpenContainer except that new container is not created
  77             // but c is used. You can use this to directly set actual container
  78         wxHtmlContainerCell *CloseContainer();
  79             // closes the container and sets actual Container to upper-level
  80             // container
  81
  82         int GetFontSize() const {return m_FontSize;}
  83         void SetFontSize(int s);
  84         int GetFontBold() const {return m_FontBold;}
  85         void SetFontBold(int x) {m_FontBold = x;}
  86         int GetFontItalic() const {return m_FontItalic;}
  87         void SetFontItalic(int x) {m_FontItalic = x;}
  88         int GetFontUnderlined() const {return m_FontUnderlined;}
  89         void SetFontUnderlined(int x) {m_FontUnderlined = x;}
  90         int GetFontFixed() const {return m_FontFixed;}
  91         void SetFontFixed(int x) {m_FontFixed = x;}
  92         wxString GetFontFace() const {return GetFontFixed() ? m_FontFaceFixed : m_FontFaceNormal;}
  93         void SetFontFace(const wxString& face) {if (GetFontFixed()) m_FontFaceFixed = face; else m_FontFaceNormal = face;}
  94
  95         int GetAlign() const {return m_Align;}
  96         void SetAlign(int a) {m_Align = a;}
  97         const wxColour& GetLinkColor() const {return m_LinkColor;}
  98         void SetLinkColor(const wxColour& clr) {m_LinkColor = clr;}
  99         const wxColour& GetActualColor() const {return m_ActualColor;}
 100         void SetActualColor(const wxColour& clr) {m_ActualColor = clr;}
 101         const wxHtmlLinkInfo& GetLink() const {return m_Link;}
 102         void SetLink(const wxHtmlLinkInfo& link);
 103
 104         virtual wxFont* CreateCurrentFont();
 105             // creates font depending on m_Font* members.
 106
 107     protected:
 108         virtual void AddText(const char *txt);
 109
 110     private:
 111         bool m_tmpLastWasSpace;
 112             // temporary variable used by AddText
 113         wxWindow *m_Window;
 114                 // window we're parsing for
 115         double m_PixelScale;
 116         wxDC *m_DC;
 117                 // Device Context we're parsing for
 118         static wxList m_Modules;
 119                 // list of tags modules (see wxHtmlTagsModule for details)
 120                 // This list is used to initialize m_Handlers member.
 121
 122         wxHtmlContainerCell *m_Container;
 123                 // actual container. See Open/CloseContainer for details.
 124
 125         int m_FontBold, m_FontItalic, m_FontUnderlined, m_FontFixed; // this is not TRUE,FALSE but 1,0, we need it for indexing
 126         int m_FontSize; /* -2 to +4,  0 is default */
 127         wxColour m_LinkColor;
 128         wxColour m_ActualColor;
 129                 // basic font parameters.
 130         wxHtmlLinkInfo m_Link;
 131                 // actual hypertext link or empty string
 132         bool m_UseLink;
 133                 // TRUE if m_Link is not empty
 134         long m_CharHeight, m_CharWidth;
 135                 // average height of normal-sized text
 136         int m_Align;
 137                 // actual alignment
 138
 139         wxFont* m_FontsTable[2][2][2][2][7];
 140         wxString m_FontsFacesTable[2][2][2][2][7];
 141                 // table of loaded fonts. 1st four indexes are 0 or 1, depending on on/off
 142                 // state of these flags (from left to right):
 143                 // [bold][italic][underlined][fixed_size]
 144                 // last index is font size : from 0 to 6 (remapped from html sizes 1 to 7)
 145                 // Note : this table covers all possible combinations of fonts, but not
 146                 // all of them are used, so many items in table are usually NULL.
 147         int m_FontsSizes[7];
 148         wxString m_FontFaceFixed, m_FontFaceNormal;
 149                 // html font sizes and faces of fixed and proportional fonts
 150 };
 151
 152
 153
 154
 155
 156
 157 //--------------------------------------------------------------------------------
 158 // wxHtmlWinTagHandler
 159 //                  This is basicly wxHtmlTagHandler except
 160 //                  it is extended with protected member m_Parser pointing to
 161 //                  the wxHtmlWinParser object
 162 //--------------------------------------------------------------------------------
 163
 164 class WXDLLEXPORT wxHtmlWinTagHandler : public wxHtmlTagHandler
 165 {
 166     DECLARE_ABSTRACT_CLASS(wxHtmlWinTagHandler)
 167
 168     public:
 169         wxHtmlWinTagHandler() : wxHtmlTagHandler() {};
 170
 171         virtual void SetParser(wxHtmlParser *parser) {wxHtmlTagHandler::SetParser(parser); m_WParser = (wxHtmlWinParser*) parser;};
 172
 173     protected:
 174         wxHtmlWinParser *m_WParser;
 175                 // same as m_Parser, but overcasted
 176 };
 177
 178
 179
 180
 181
 182
 183 //--------------------------------------------------------------------------------
 184 // wxHtmlTagsModule
 185 //                  This is basic of dynamic tag handlers binding.
 186 //                  The class provides methods for filling parser's handlers
 187 //                  hash table.
 188 //                  (See documentation for details)
 189 //--------------------------------------------------------------------------------
 190
 191 class WXDLLEXPORT wxHtmlTagsModule : public wxModule
 192 {
 193     DECLARE_DYNAMIC_CLASS(wxHtmlTagsModule)
 194
 195     public:
 196         wxHtmlTagsModule() : wxModule() {};
 197
 198         virtual bool OnInit();
 199         virtual void OnExit();
 200
 201         virtual void FillHandlersTable(wxHtmlWinParser * WXUNUSED(parser)) { }
 202                 // This is called by wxHtmlWinParser.
 203                 // The method must simply call parser->AddTagHandler(new <handler_class_name>);
 204                 // for each handler
 205
 206 };
 207
 208
 209 #endif
 210
 211 #endif // _WX_WINPARS_H_
 212
 213
 214
 215