Docstring fixes

[wxWidgets.git] / src / msw / pen.cpp

diff --git a/src/msw/pen.cpp b/src/msw/pen.cpp
index 50f821006a8042c5f1fc6e6838a4cb7de46e02f1..ce9d1dc9e898de6656484b40f2e36a5fd353b60c 100644 (file)
--- a/src/msw/pen.cpp
+++ b/src/msw/pen.cpp
@@ -1,15 +1,15 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        pen.cpp
+// Name:        msw/pen.cpp

 // Purpose:     wxPen
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Purpose:     wxPen
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

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

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

 #pragma implementation "pen.h"
 #endif
 
 #pragma implementation "pen.h"
 #endif
 


@@ -30,11 +30,10 @@
 #endif
 
 #include "wx/msw/private.h"
 #endif
 
 #include "wx/msw/private.h"

-#include "assert.h"

 
 

-#if !USE_SHARED_LIBRARIES
+static int wx2msPenStyle(int wx_style);
+

 IMPLEMENT_DYNAMIC_CLASS(wxPen, wxGDIObject)
 IMPLEMENT_DYNAMIC_CLASS(wxPen, wxGDIObject)

-#endif

 
 wxPenRefData::wxPenRefData()
 {
 
 wxPenRefData::wxPenRefData()
 {


@@ -43,11 +42,12 @@ wxPenRefData::wxPenRefData()
   m_join = wxJOIN_ROUND ;
   m_cap = wxCAP_ROUND ;
   m_nbDash = 0 ;
   m_join = wxJOIN_ROUND ;
   m_cap = wxCAP_ROUND ;
   m_nbDash = 0 ;

-  m_dash = 0 ;
+  m_dash = (wxDash*)NULL;

   m_hPen = 0;
 }
 
 wxPenRefData::wxPenRefData(const wxPenRefData& data)
   m_hPen = 0;
 }
 
 wxPenRefData::wxPenRefData(const wxPenRefData& data)

+             :wxGDIRefData()

 {
     m_style = data.m_style;
     m_width = data.m_width;
 {
     m_style = data.m_style;
     m_width = data.m_width;


@@ -61,22 +61,18 @@ wxPenRefData::wxPenRefData(const wxPenRefData& data)
 
 wxPenRefData::~wxPenRefData()
 {
 
 wxPenRefData::~wxPenRefData()
 {

-       if ( m_hPen )
-               ::DeleteObject((HPEN) m_hPen);
+    if ( m_hPen )
+        ::DeleteObject((HPEN) m_hPen);

 }
 
 // Pens
 
 wxPen::wxPen()
 {
 }
 
 // Pens
 
 wxPen::wxPen()
 {

-  if ( wxThePenList )
-    wxThePenList->AddPen(this);

 }
 
 wxPen::~wxPen()
 {
 }
 
 wxPen::~wxPen()
 {

-    if (wxThePenList)
-        wxThePenList->RemovePen(this);

 }
 
 // Should implement Create
 }
 
 // Should implement Create


@@ -91,192 +87,197 @@ wxPen::wxPen(const wxColour& col, int Width, int Style)
   M_PENDATA->m_join = wxJOIN_ROUND ;
   M_PENDATA->m_cap = wxCAP_ROUND ;
   M_PENDATA->m_nbDash = 0 ;
   M_PENDATA->m_join = wxJOIN_ROUND ;
   M_PENDATA->m_cap = wxCAP_ROUND ;
   M_PENDATA->m_nbDash = 0 ;

-  M_PENDATA->m_dash = 0 ;
+  M_PENDATA->m_dash = (wxDash*)NULL;

   M_PENDATA->m_hPen = 0 ;
 
   M_PENDATA->m_hPen = 0 ;
 

-#ifndef __WIN32__
-  // In Windows, only a pen of width = 1 can be dotted or dashed!
-  if ((Style == wxDOT) || (Style == wxLONG_DASH) ||
-      (Style == wxSHORT_DASH) || (Style == wxDOT_DASH) ||
-      (Style == wxUSER_DASH))
-    M_PENDATA->m_width = 1;
-#else
-/***
-  DWORD vers = GetVersion() ;
-  WORD  high = HIWORD(vers) ; // high bit=0 for NT, 1 for Win32s
-  // Win32s doesn't support wide dashed pens
-
-  if ((high&0x8000)!=0)
-***/
-  if (wxGetOsVersion()==wxWIN32S)
-  {
-    // In Windows, only a pen of width = 1 can be dotted or dashed!
-    if ((Style == wxDOT) || (Style == wxLONG_DASH) ||
-        (Style == wxSHORT_DASH) || (Style == wxDOT_DASH) ||
-        (Style == wxUSER_DASH))
-      M_PENDATA->m_width = 1;
-  }
-#endif 

   RealizeResource();
   RealizeResource();

-
-  if ( wxThePenList )
-    wxThePenList->AddPen(this);

 }
 
 wxPen::wxPen(const wxBitmap& stipple, int Width)
 {
 }
 
 wxPen::wxPen(const wxBitmap& stipple, int Width)
 {

-  m_refData = new wxPenRefData;
+    m_refData = new wxPenRefData;

 
 //  M_PENDATA->m_colour = col;
 
 //  M_PENDATA->m_colour = col;

-  M_PENDATA->m_stipple = stipple;
-  M_PENDATA->m_width = Width;
-  M_PENDATA->m_style = wxSTIPPLE;
-  M_PENDATA->m_join = wxJOIN_ROUND ;
-  M_PENDATA->m_cap = wxCAP_ROUND ;
-  M_PENDATA->m_nbDash = 0 ;
-  M_PENDATA->m_dash = 0 ;
-  M_PENDATA->m_hPen = 0 ;
-
-  RealizeResource();
+    M_PENDATA->m_stipple = stipple;
+    M_PENDATA->m_width = Width;
+    M_PENDATA->m_style = wxSTIPPLE;
+    M_PENDATA->m_join = wxJOIN_ROUND ;
+    M_PENDATA->m_cap = wxCAP_ROUND ;
+    M_PENDATA->m_nbDash = 0 ;
+    M_PENDATA->m_dash = (wxDash*)NULL;
+    M_PENDATA->m_hPen = 0 ;

 
 

-  if ( wxThePenList )
-    wxThePenList->AddPen(this);
+    RealizeResource();

 }
 
 bool wxPen::RealizeResource()
 {
 }
 
 bool wxPen::RealizeResource()
 {

-  if (M_PENDATA && (M_PENDATA->m_hPen == 0))
-  {
-    if (M_PENDATA->m_style==wxTRANSPARENT)
-    {
-      M_PENDATA->m_hPen = (WXHPEN) ::GetStockObject(NULL_PEN);
-      return TRUE;
-    }
-
-    COLORREF ms_colour = 0 ;
-    ms_colour = M_PENDATA->m_colour.GetPixel() ;
-
-    // Join style, Cap style, Pen Stippling only on Win32.
-    // Currently no time to find equivalent on Win3.1, sorry
-    // [if such equiv exist!!]
-#ifdef __WIN32__
-    if (M_PENDATA->m_join==wxJOIN_ROUND        &&
-        M_PENDATA->m_cap==wxCAP_ROUND          &&
-        M_PENDATA->m_style!=wxUSER_DASH        &&
-        M_PENDATA->m_style!=wxSTIPPLE          &&
-        M_PENDATA->m_width <= 1
-       )
-      M_PENDATA->m_hPen = (WXHPEN) CreatePen(wx2msPenStyle(M_PENDATA->m_style), M_PENDATA->m_width, ms_colour);
-    else
-    {
-      DWORD ms_style = PS_GEOMETRIC|wx2msPenStyle(M_PENDATA->m_style) ;
-
-      LOGBRUSH logb ;
-
-      switch(M_PENDATA->m_join)
-      {
-        case wxJOIN_BEVEL: ms_style |= PS_JOIN_BEVEL ; break ;
-        case wxJOIN_MITER: ms_style |= PS_JOIN_MITER ; break ;
-        default:
-        case wxJOIN_ROUND: ms_style |= PS_JOIN_ROUND ; break ;
-      }
-
-      switch(M_PENDATA->m_cap)
-      {
-        case wxCAP_PROJECTING: ms_style |= PS_ENDCAP_SQUARE ; break ;
-        case wxCAP_BUTT:       ms_style |= PS_ENDCAP_FLAT ;   break ;
-        default:
-        case wxCAP_ROUND:      ms_style |= PS_ENDCAP_ROUND ;  break ;
-      }
-
-      switch(M_PENDATA->m_style)
-      {
-        case wxSTIPPLE:
-          logb.lbStyle = BS_PATTERN ;
-          if (M_PENDATA->m_stipple.Ok())
-            logb.lbHatch = (LONG)M_PENDATA->m_stipple.GetHBITMAP() ;
-          else
-            logb.lbHatch = (LONG)0 ;
-        break ;
-        case wxBDIAGONAL_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_BDIAGONAL ;
-        break ;
-        case wxCROSSDIAG_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_DIAGCROSS ;
-        break ;
-        case wxFDIAGONAL_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_FDIAGONAL ;
-        break ;
-        case wxCROSS_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_CROSS ;
-        break ;
-        case wxHORIZONTAL_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_HORIZONTAL ;
-        break ;
-        case wxVERTICAL_HATCH:
-          logb.lbStyle = BS_HATCHED ;
-          logb.lbHatch = HS_VERTICAL ;
-        break ;
-        default:
-          logb.lbStyle = BS_SOLID ;
-        break ;
-      }
-      logb.lbColor = ms_colour ;
-      wxDash *real_dash ;
-      if (M_PENDATA->m_style==wxUSER_DASH && M_PENDATA->m_nbDash && M_PENDATA->m_dash)
-      {
-        real_dash = new wxDash[M_PENDATA->m_nbDash] ;
-        int i;
-        for (i=0;i<M_PENDATA->m_nbDash;i++)
-          real_dash[i] = M_PENDATA->m_dash[i] * M_PENDATA->m_width ;
-      }
-      else
-        real_dash = 0 ;
-
-      // Win32s doesn't have ExtCreatePen function...
-      if (wxGetOsVersion()==wxWINDOWS_NT || wxGetOsVersion()==wxWIN95)
-        M_PENDATA->m_hPen = (WXHPEN) ExtCreatePen(ms_style,M_PENDATA->m_width,&logb,
-                            M_PENDATA->m_style==wxUSER_DASH ? M_PENDATA->m_nbDash:0, (const DWORD *)real_dash);
-      else
-        M_PENDATA->m_hPen = (WXHPEN) CreatePen(wx2msPenStyle(M_PENDATA->m_style), M_PENDATA->m_width, ms_colour);
-
-      if (real_dash)
-        delete [] real_dash ;
-    }
-#else
-    M_PENDATA->m_hPen = (WXHPEN) CreatePen(wx2msPenStyle(M_PENDATA->m_style), M_PENDATA->m_width, ms_colour);
+   if ( !M_PENDATA || M_PENDATA->m_hPen )
+       return false;
+
+   if (M_PENDATA->m_style==wxTRANSPARENT)
+   {
+       M_PENDATA->m_hPen = (WXHPEN) ::GetStockObject(NULL_PEN);
+       return true;
+   }
+
+   static const int os = wxGetOsVersion();
+   COLORREF ms_colour = M_PENDATA->m_colour.GetPixel();
+
+   // Join style, Cap style, Pen Stippling
+#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
+   // Only NT can display dashed or dotted lines with width > 1
+   if ( os != wxWINDOWS_NT &&
+           (M_PENDATA->m_style & (wxDOT |
+                                  wxLONG_DASH |
+                                  wxSHORT_DASH |
+                                  wxDOT_DASH |
+                                  wxUSER_DASH)) &&
+            M_PENDATA->m_width > 1 )
+   {
+       M_PENDATA->m_width = 1;
+   }
+
+   if (M_PENDATA->m_join==wxJOIN_ROUND        &&
+       M_PENDATA->m_cap==wxCAP_ROUND          &&
+       M_PENDATA->m_style!=wxUSER_DASH        &&
+       M_PENDATA->m_style!=wxSTIPPLE          &&
+       M_PENDATA->m_width <= 1)
+   {
+       M_PENDATA->m_hPen =
+         (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
+                             M_PENDATA->m_width,
+                             ms_colour );
+   }
+   else
+   {
+       DWORD ms_style = PS_GEOMETRIC | wx2msPenStyle(M_PENDATA->m_style);
+
+       switch(M_PENDATA->m_join)
+       {
+           case wxJOIN_BEVEL: ms_style |= PS_JOIN_BEVEL; break;
+           case wxJOIN_MITER: ms_style |= PS_JOIN_MITER; break;
+           default:
+           case wxJOIN_ROUND: ms_style |= PS_JOIN_ROUND; break;
+       }
+
+       switch(M_PENDATA->m_cap)
+       {
+           case wxCAP_PROJECTING: ms_style |= PS_ENDCAP_SQUARE;  break;
+           case wxCAP_BUTT:       ms_style |= PS_ENDCAP_FLAT;    break;
+           default:
+           case wxCAP_ROUND:      ms_style |= PS_ENDCAP_ROUND;   break;
+       }
+
+       LOGBRUSH logb;
+
+       switch(M_PENDATA->m_style)
+       {
+           case wxSTIPPLE:
+               logb.lbStyle = BS_PATTERN ;
+               if (M_PENDATA->m_stipple.Ok())
+                   logb.lbHatch = (LONG)M_PENDATA->m_stipple.GetHBITMAP();
+               else
+                   logb.lbHatch = (LONG)0;
+               break;
+           case wxBDIAGONAL_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_BDIAGONAL;
+               break;
+           case wxCROSSDIAG_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_DIAGCROSS;
+               break;
+           case wxFDIAGONAL_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_FDIAGONAL;
+               break;
+           case wxCROSS_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_CROSS;
+               break;
+           case wxHORIZONTAL_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_HORIZONTAL;
+               break;
+           case wxVERTICAL_HATCH:
+               logb.lbStyle = BS_HATCHED;
+               logb.lbHatch = HS_VERTICAL;
+               break;
+           default:
+               logb.lbStyle = BS_SOLID;
+#ifdef __WXDEBUG__
+               // this should be unnecessary (it's unused) but suppresses the Purify
+               // messages about uninitialized memory read
+               logb.lbHatch = 0;

 #endif
 #endif

-#ifdef WXDEBUG_CREATE
-    if (M_PENDATA->m_hPen==0)
-      wxError("Cannot create pen","Internal error") ;
-#endif
-    return TRUE;
-  }
-  return FALSE;
+               break;
+       }
+
+       logb.lbColor = ms_colour;
+
+       wxMSWDash *real_dash;
+       if (M_PENDATA->m_style==wxUSER_DASH && M_PENDATA->m_nbDash && M_PENDATA->m_dash)
+       {
+           real_dash = new wxMSWDash[M_PENDATA->m_nbDash];
+           int rw = M_PENDATA->m_width > 1 ? M_PENDATA->m_width : 1;
+           for ( int i = 0; i < M_PENDATA->m_nbDash; i++ )
+               real_dash[i] = M_PENDATA->m_dash[i] * rw;
+       }
+       else
+       {
+           real_dash = (wxMSWDash*)NULL;
+       }
+
+       // Win32s doesn't have ExtCreatePen function...
+       if (os==wxWINDOWS_NT || os==wxWIN95)
+       {
+           M_PENDATA->m_hPen =
+             (WXHPEN) ExtCreatePen( ms_style,
+                                    M_PENDATA->m_width,
+                                    &logb,
+                                    M_PENDATA->m_style == wxUSER_DASH
+                                      ? M_PENDATA->m_nbDash
+                                      : 0,
+                                    (LPDWORD)real_dash );
+       }
+       else
+       {
+           M_PENDATA->m_hPen =
+              (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
+                                  M_PENDATA->m_width,
+                                  ms_colour );
+       }
+
+       delete [] real_dash;
+   }
+#else // WinCE
+   M_PENDATA->m_hPen =
+     (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
+                         M_PENDATA->m_width,
+                         ms_colour );
+#endif // !WinCE/WinCE
+
+   return true;

 }
 
 }
 

-WXHANDLE wxPen::GetResourceHandle()
+WXHANDLE wxPen::GetResourceHandle() const

 {
 {

-       if ( !M_PENDATA )
-               return 0;
-       else
-               return (WXHANDLE)M_PENDATA->m_hPen;
+        if ( !M_PENDATA )
+                return 0;
+        else
+                return (WXHANDLE)M_PENDATA->m_hPen;

 }
 
 }
 

-bool wxPen::FreeResource(bool force)
+bool wxPen::FreeResource(bool WXUNUSED(force))

 {
   if (M_PENDATA && (M_PENDATA->m_hPen != 0))
   {
     DeleteObject((HPEN) M_PENDATA->m_hPen);
     M_PENDATA->m_hPen = 0;
 {
   if (M_PENDATA && (M_PENDATA->m_hPen != 0))
   {
     DeleteObject((HPEN) M_PENDATA->m_hPen);
     M_PENDATA->m_hPen = 0;

-    return TRUE;
+    return true;

   }
   }

-  else return FALSE;
+  else return false;

 }
 
 bool wxPen::IsFree() const
 }
 
 bool wxPen::IsFree() const


@@ -286,17 +287,17 @@ bool wxPen::IsFree() const
 
 void wxPen::Unshare()
 {
 
 void wxPen::Unshare()
 {

-       // Don't change shared data
-       if (!m_refData)
+        // Don't change shared data
+        if (!m_refData)

     {
     {

-               m_refData = new wxPenRefData();
-       }
+                m_refData = new wxPenRefData();
+        }

     else
     {
     else
     {

-               wxPenRefData* ref = new wxPenRefData(*(wxPenRefData*)m_refData);
-               UnRef();
-               m_refData = ref;
-       }
+                wxPenRefData* ref = new wxPenRefData(*(wxPenRefData*)m_refData);
+                UnRef();
+                m_refData = ref;
+        }

 }
 
 void wxPen::SetColour(const wxColour& col)
 }
 
 void wxPen::SetColour(const wxColour& col)


@@ -304,7 +305,7 @@ void wxPen::SetColour(const wxColour& col)
     Unshare();
 
     M_PENDATA->m_colour = col;
     Unshare();
 
     M_PENDATA->m_colour = col;

-  
+

     RealizeResource();
 }
 
     RealizeResource();
 }
 


@@ -313,7 +314,7 @@ void wxPen::SetColour(unsigned char r, unsigned char g, unsigned char b)
     Unshare();
 
     M_PENDATA->m_colour.Set(r, g, b);
     Unshare();
 
     M_PENDATA->m_colour.Set(r, g, b);

-  
+

     RealizeResource();
 }
 
     RealizeResource();
 }
 


@@ -341,7 +342,7 @@ void wxPen::SetStipple(const wxBitmap& Stipple)
 
     M_PENDATA->m_stipple = Stipple;
     M_PENDATA->m_style = wxSTIPPLE;
 
     M_PENDATA->m_stipple = Stipple;
     M_PENDATA->m_style = wxSTIPPLE;

-  
+

     RealizeResource();
 }
 
     RealizeResource();
 }
 


@@ -351,7 +352,7 @@ void wxPen::SetDashes(int nb_dashes, const wxDash *Dash)
 
     M_PENDATA->m_nbDash = nb_dashes;
     M_PENDATA->m_dash = (wxDash *)Dash;
 
     M_PENDATA->m_nbDash = nb_dashes;
     M_PENDATA->m_dash = (wxDash *)Dash;

-  
+

     RealizeResource();
 }
 
     RealizeResource();
 }
 


@@ -375,45 +376,29 @@ void wxPen::SetCap(int Cap)
 
 int wx2msPenStyle(int wx_style)
 {
 
 int wx2msPenStyle(int wx_style)
 {

-  int cstyle;
-/***
-#ifdef __WIN32__
-  DWORD vers = GetVersion() ;
-  WORD  high = HIWORD(vers) ; // high bit=0 for NT, 1 for Win32s
-#endif
-***/
-  switch (wx_style)
-  {
-    case wxDOT:
-      cstyle = PS_DOT;
-      break;
-    case wxSHORT_DASH:
-    case wxLONG_DASH:
-      cstyle = PS_DASH;
-      break;
-    case wxTRANSPARENT:
-      cstyle = PS_NULL;
-      break;
-    case wxUSER_DASH:
-      // User dash style not supported on Win3.1, sorry...
-#ifdef __WIN32__
-      // Win32s doesn't have PS_USERSTYLE
-/***
-      if ((high&0x8000)==0)
-***/
-      if (wxGetOsVersion()==wxWINDOWS_NT)
-        cstyle = PS_USERSTYLE ;
-      else
-        cstyle = PS_DOT ; // We must make a choice... This is mine!
+#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
+    switch (wx_style)
+    {
+        case wxDOT:
+            return PS_DOT;
+
+        case wxDOT_DASH:
+            return PS_DASHDOT;
+
+        case wxSHORT_DASH:
+        case wxLONG_DASH:
+            return PS_DASH;
+
+        case wxTRANSPARENT:
+            return PS_NULL;
+
+        case wxUSER_DASH:
+            // if (wxGetOsVersion()==wxWINDOWS_NT || wxGetOsVersion()==wxWIN95)
+                return PS_USERSTYLE;
+    }

 #else
 #else

-      cstyle = PS_DASH ;
+    wxUnusedVar(wx_style);

 #endif
 #endif

-      break ;
-    case wxSOLID:
-    default:
-      cstyle = PS_SOLID;
-      break;
-  }
-  return cstyle;
+    return PS_SOLID;

 }
 
 }