Add docstrings for wxSTC methods

[wxWidgets.git] / src / html / m_hline.cpp

diff --git a/src/html/m_hline.cpp b/src/html/m_hline.cpp
index c4099f34a4187ec949ac3b3c6dab171d1d2b0b19..d629fda7bc613b961d78dd3bd1f438546647e7b7 100644 (file)
--- a/src/html/m_hline.cpp
+++ b/src/html/m_hline.cpp
@@ -1,13 +1,13 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        mod_hline.cpp
+// Name:        m_hline.cpp

 // Purpose:     wxHtml module for horizontal line (HR tag)
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik
 // Purpose:     wxHtml module for horizontal line (HR tag)
 // Author:      Vaclav Slavik
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vaclav Slavik

-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma implementation
 #endif
 
 #pragma implementation
 #endif
 


@@ -15,23 +15,23 @@
 
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"

-#if wxUSE_HTML
-#ifdef __BORDLANDC__
+#if wxUSE_HTML && wxUSE_STREAMS
+#ifdef __BORLANDC__

 #pragma hdrstop
 #endif
 
 #ifndef WXPRECOMP
 #pragma hdrstop
 #endif
 
 #ifndef WXPRECOMP

-#include "wx/wx.h"
+    #include "wx/brush.h"
+    #include "wx/pen.h"
+    #include "wx/dc.h"

 #endif
 
 #endif
 

-
-

 #include "wx/html/forcelnk.h"
 #include "wx/html/m_templ.h"
 
 #include "wx/html/htmlcell.h"
 
 #include "wx/html/forcelnk.h"
 #include "wx/html/m_templ.h"
 
 #include "wx/html/htmlcell.h"
 

-FORCE_LINK_ME(mod_hline)
+FORCE_LINK_ME(m_hline)

 
 
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------


@@ -41,20 +41,29 @@ FORCE_LINK_ME(mod_hline)
 class wxHtmlLineCell : public wxHtmlCell
 {
     public:
 class wxHtmlLineCell : public wxHtmlCell
 {
     public:

-        wxHtmlLineCell(int size) : wxHtmlCell() {m_Height = size;}
-        void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
-        void Layout(int w) {m_Width = w; if (m_Next) m_Next -> Layout(w);}
+        wxHtmlLineCell(int size, bool shading) : wxHtmlCell() {m_Height = size; m_HasShading = shading;}
+        void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
+                  wxHtmlRenderingInfo& info);
+        void Layout(int w)
+            { m_Width = w; wxHtmlCell::Layout(w); }
+
+    private:
+        // Should we draw 3-D shading or not
+      bool m_HasShading;
+
+      DECLARE_NO_COPY_CLASS(wxHtmlLineCell)

 };
 
 
 };
 
 

-void wxHtmlLineCell::Draw(wxDC& dc, int x, int y, int view_y1, int view_y2)
+void wxHtmlLineCell::Draw(wxDC& dc, int x, int y,
+                          int WXUNUSED(view_y1), int WXUNUSED(view_y2),
+                          wxHtmlRenderingInfo& WXUNUSED(info))

 {
 {

-    wxBrush mybrush("BLACK", wxSOLID);
-    wxPen mypen("BLACK", 1, wxSOLID);
+    wxBrush mybrush(wxT("GREY"), (m_HasShading) ? wxTRANSPARENT : wxSOLID);
+    wxPen mypen(wxT("GREY"), 1, wxSOLID);

     dc.SetBrush(mybrush);
     dc.SetPen(mypen);
     dc.DrawRectangle(x + m_PosX, y + m_PosY, m_Width, m_Height);
     dc.SetBrush(mybrush);
     dc.SetPen(mypen);
     dc.DrawRectangle(x + m_PosX, y + m_PosY, m_Width, m_Height);

-    wxHtmlCell::Draw(dc, x, y, view_y1, view_y2);

 }
 
 
 }
 
 


@@ -66,27 +75,30 @@ void wxHtmlLineCell::Draw(wxDC& dc, int x, int y, int view_y1, int view_y2)
 
 
 TAG_HANDLER_BEGIN(HR, "HR")
 
 
 TAG_HANDLER_BEGIN(HR, "HR")

+    TAG_HANDLER_CONSTR(HR) { }

 
     TAG_HANDLER_PROC(tag)
     {
         wxHtmlContainerCell *c;
         int sz;
 
     TAG_HANDLER_PROC(tag)
     {
         wxHtmlContainerCell *c;
         int sz;

+        bool HasShading;

 
 

-        m_WParser -> CloseContainer();
-        c = m_WParser -> OpenContainer();
+        m_WParser->CloseContainer();
+        c = m_WParser->OpenContainer();

 
 

-        c -> SetIndent(m_WParser -> GetCharHeight(), wxHTML_INDENT_VERTICAL);
-        c -> SetAlignHor(wxHTML_ALIGN_CENTER);
-        c -> SetAlign(tag);
-        c -> SetWidthFloat(tag);
+        c->SetIndent(m_WParser->GetCharHeight(), wxHTML_INDENT_VERTICAL);
+        c->SetAlignHor(wxHTML_ALIGN_CENTER);
+        c->SetAlign(tag);
+        c->SetWidthFloat(tag);

         sz = 1;
         sz = 1;

-        if (tag.HasParam(wxT("SIZE")) && tag.ScanParam(wxT("SIZE"), wxT("%i"), &sz) == 1) {}
-        c -> InsertCell(new wxHtmlLineCell(sz));
+        tag.GetParamAsInt(wxT("SIZE"), &sz);
+        HasShading = !(tag.HasParam(wxT("NOSHADE")));
+        c->InsertCell(new wxHtmlLineCell((int)((double)sz * m_WParser->GetPixelScale()), HasShading));

 
 

-        m_WParser -> CloseContainer();
-        m_WParser -> OpenContainer();
+        m_WParser->CloseContainer();
+        m_WParser->OpenContainer();

 
 

-        return FALSE;
+        return false;

     }
 
 TAG_HANDLER_END(HR)
     }
 
 TAG_HANDLER_END(HR)