src/msw/pen.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/pen.cpp
   3 // Purpose:     wxPen
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation "pen.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20 #pragma hdrstop
  21 #endif
  22
  23 #ifndef WX_PRECOMP
  24 #include <stdio.h>
  25 #include "wx/setup.h"
  26 #include "wx/list.h"
  27 #include "wx/utils.h"
  28 #include "wx/app.h"
  29 #include "wx/pen.h"
  30 #endif
  31
  32 #include "wx/msw/private.h"
  33
  34 IMPLEMENT_DYNAMIC_CLASS(wxPen, wxGDIObject)
  35
  36 wxPenRefData::wxPenRefData()
  37 {
  38   m_style = wxSOLID;
  39   m_width = 1;
  40   m_join = wxJOIN_ROUND ;
  41   m_cap = wxCAP_ROUND ;
  42   m_nbDash = 0 ;
  43   m_dash = (wxDash*)NULL;
  44   m_hPen = 0;
  45 }
  46
  47 wxPenRefData::wxPenRefData(const wxPenRefData& data)
  48 {
  49     m_style = data.m_style;
  50     m_width = data.m_width;
  51     m_join = data.m_join;
  52     m_cap = data.m_cap;
  53     m_nbDash = data.m_nbDash;
  54     m_dash = data.m_dash;
  55     m_colour = data.m_colour;
  56     m_hPen = 0;
  57 }
  58
  59 wxPenRefData::~wxPenRefData()
  60 {
  61         if ( m_hPen )
  62                 ::DeleteObject((HPEN) m_hPen);
  63 }
  64
  65 // Pens
  66
  67 wxPen::wxPen()
  68 {
  69 }
  70
  71 wxPen::~wxPen()
  72 {
  73 }
  74
  75 // Should implement Create
  76 wxPen::wxPen(const wxColour& col, int Width, int Style)
  77 {
  78   m_refData = new wxPenRefData;
  79
  80   M_PENDATA->m_colour = col;
  81 //  M_PENDATA->m_stipple = NULL;
  82   M_PENDATA->m_width = Width;
  83   M_PENDATA->m_style = Style;
  84   M_PENDATA->m_join = wxJOIN_ROUND ;
  85   M_PENDATA->m_cap = wxCAP_ROUND ;
  86   M_PENDATA->m_nbDash = 0 ;
  87   M_PENDATA->m_dash = (wxDash*)NULL;
  88   M_PENDATA->m_hPen = 0 ;
  89
  90 #ifndef __WIN32__
  91   // In Windows, only a pen of width = 1 can be dotted or dashed!
  92   if ((Style == wxDOT) || (Style == wxLONG_DASH) ||
  93       (Style == wxSHORT_DASH) || (Style == wxDOT_DASH) ||
  94       (Style == wxUSER_DASH))
  95     M_PENDATA->m_width = 1;
  96 #else
  97 /***
  98   DWORD vers = GetVersion() ;
  99   WORD  high = HIWORD(vers) ; // high bit=0 for NT, 1 for Win32s
 100   // Win32s doesn't support wide dashed pens
 101
 102   if ((high&0x8000)!=0)
 103 ***/
 104   if (wxGetOsVersion()==wxWIN32S)
 105   {
 106     // In Windows, only a pen of width = 1 can be dotted or dashed!
 107     if ((Style == wxDOT) || (Style == wxLONG_DASH) ||
 108         (Style == wxSHORT_DASH) || (Style == wxDOT_DASH) ||
 109         (Style == wxUSER_DASH))
 110       M_PENDATA->m_width = 1;
 111   }
 112 #endif
 113   RealizeResource();
 114
 115 }
 116
 117 wxPen::wxPen(const wxBitmap& stipple, int Width)
 118 {
 119     m_refData = new wxPenRefData;
 120
 121 //  M_PENDATA->m_colour = col;
 122     M_PENDATA->m_stipple = stipple;
 123     M_PENDATA->m_width = Width;
 124     M_PENDATA->m_style = wxSTIPPLE;
 125     M_PENDATA->m_join = wxJOIN_ROUND ;
 126     M_PENDATA->m_cap = wxCAP_ROUND ;
 127     M_PENDATA->m_nbDash = 0 ;
 128     M_PENDATA->m_dash = (wxDash*)NULL;
 129     M_PENDATA->m_hPen = 0 ;
 130
 131     RealizeResource();
 132
 133 }
 134
 135 bool wxPen::RealizeResource()
 136 {
 137    if (M_PENDATA && (M_PENDATA->m_hPen == 0))
 138    {
 139        if (M_PENDATA->m_style==wxTRANSPARENT)
 140        {
 141            M_PENDATA->m_hPen = (WXHPEN) ::GetStockObject(NULL_PEN);
 142            return TRUE;
 143        }
 144
 145        COLORREF ms_colour = 0;
 146        ms_colour = M_PENDATA->m_colour.GetPixel();
 147
 148        // Join style, Cap style, Pen Stippling only on Win32.
 149        // Currently no time to find equivalent on Win3.1, sorry
 150        // [if such equiv exist!!]
 151 #if defined(__WIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 152        if (M_PENDATA->m_join==wxJOIN_ROUND        &&
 153            M_PENDATA->m_cap==wxCAP_ROUND          &&
 154            M_PENDATA->m_style!=wxUSER_DASH        &&
 155            M_PENDATA->m_style!=wxSTIPPLE          &&
 156            M_PENDATA->m_width <= 1)
 157        {
 158            M_PENDATA->m_hPen =
 159              (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
 160                                  M_PENDATA->m_width,
 161                                  ms_colour );
 162        }
 163        else
 164        {
 165            DWORD ms_style = PS_GEOMETRIC | wx2msPenStyle(M_PENDATA->m_style);
 166
 167            switch(M_PENDATA->m_join)
 168            {
 169                case wxJOIN_BEVEL: ms_style |= PS_JOIN_BEVEL; break;
 170                case wxJOIN_MITER: ms_style |= PS_JOIN_MITER; break;
 171                default:
 172                case wxJOIN_ROUND: ms_style |= PS_JOIN_ROUND; break;
 173            }
 174
 175            switch(M_PENDATA->m_cap)
 176            {
 177                case wxCAP_PROJECTING: ms_style |= PS_ENDCAP_SQUARE;  break;
 178                case wxCAP_BUTT:       ms_style |= PS_ENDCAP_FLAT;    break;
 179                default:
 180                case wxCAP_ROUND:      ms_style |= PS_ENDCAP_ROUND;   break;
 181            }
 182
 183            LOGBRUSH logb;
 184
 185            switch(M_PENDATA->m_style)
 186            {
 187                case wxSTIPPLE:
 188                    logb.lbStyle = BS_PATTERN ;
 189                    if (M_PENDATA->m_stipple.Ok())
 190                        logb.lbHatch = (LONG)M_PENDATA->m_stipple.GetHBITMAP();
 191                    else
 192                        logb.lbHatch = (LONG)0;
 193                    break;
 194                case wxBDIAGONAL_HATCH:
 195                    logb.lbStyle = BS_HATCHED;
 196                    logb.lbHatch = HS_BDIAGONAL;
 197                    break;
 198                case wxCROSSDIAG_HATCH:
 199                    logb.lbStyle = BS_HATCHED;
 200                    logb.lbHatch = HS_DIAGCROSS;
 201                    break;
 202                case wxFDIAGONAL_HATCH:
 203                    logb.lbStyle = BS_HATCHED;
 204                    logb.lbHatch = HS_FDIAGONAL;
 205                    break;
 206                case wxCROSS_HATCH:
 207                    logb.lbStyle = BS_HATCHED;
 208                    logb.lbHatch = HS_CROSS;
 209                    break;
 210                case wxHORIZONTAL_HATCH:
 211                    logb.lbStyle = BS_HATCHED;
 212                    logb.lbHatch = HS_HORIZONTAL;
 213                    break;
 214                case wxVERTICAL_HATCH:
 215                    logb.lbStyle = BS_HATCHED;
 216                    logb.lbHatch = HS_VERTICAL;
 217                    break;
 218                default:
 219                    logb.lbStyle = BS_SOLID;
 220 #ifdef __WXDEBUG__
 221                    // this should be unnecessary (it's unused) but suppresses the Purigy
 222                    // messages about uninitialized memory read
 223                    logb.lbHatch = 0;
 224 #endif
 225                    break;
 226            }
 227
 228            logb.lbColor = ms_colour;
 229
 230            wxMSWDash *real_dash;
 231            if (M_PENDATA->m_style==wxUSER_DASH && M_PENDATA->m_nbDash && M_PENDATA->m_dash)
 232            {
 233                real_dash = new wxMSWDash[M_PENDATA->m_nbDash];
 234                int rw = M_PENDATA->m_width > 1 ? M_PENDATA->m_width : 1;
 235                for ( int i = 0; i < M_PENDATA->m_nbDash; i++ )
 236                    real_dash[i] = M_PENDATA->m_dash[i] * rw;
 237            }
 238            else
 239            {
 240                real_dash = (wxMSWDash*)NULL;
 241            }
 242
 243            // Win32s doesn't have ExtCreatePen function...
 244            if (wxGetOsVersion()==wxWINDOWS_NT || wxGetOsVersion()==wxWIN95)
 245            {
 246                M_PENDATA->m_hPen =
 247                  (WXHPEN) ExtCreatePen( ms_style,
 248                                         M_PENDATA->m_width,
 249                                         &logb,
 250                                         M_PENDATA->m_style == wxUSER_DASH
 251                                           ? M_PENDATA->m_nbDash
 252                                           : 0,
 253                                         (LPDWORD)real_dash );
 254            }
 255            else
 256            {
 257                M_PENDATA->m_hPen =
 258                   (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
 259                                       M_PENDATA->m_width,
 260                                       ms_colour );
 261            }
 262
 263            if (real_dash)
 264                delete [] real_dash;
 265        }
 266 #else
 267        M_PENDATA->m_hPen =
 268          (WXHPEN) CreatePen( wx2msPenStyle(M_PENDATA->m_style),
 269                              M_PENDATA->m_width,
 270                              ms_colour );
 271 #endif
 272 #ifdef WXDEBUG_CREATE
 273        if (M_PENDATA->m_hPen==0)
 274            wxError("Cannot create pen","Internal error") ;
 275 #endif
 276        return TRUE;
 277     }
 278     return FALSE;
 279 }
 280
 281 WXHANDLE wxPen::GetResourceHandle() const
 282 {
 283         if ( !M_PENDATA )
 284                 return 0;
 285         else
 286                 return (WXHANDLE)M_PENDATA->m_hPen;
 287 }
 288
 289 bool wxPen::FreeResource(bool WXUNUSED(force))
 290 {
 291   if (M_PENDATA && (M_PENDATA->m_hPen != 0))
 292   {
 293     DeleteObject((HPEN) M_PENDATA->m_hPen);
 294     M_PENDATA->m_hPen = 0;
 295     return TRUE;
 296   }
 297   else return FALSE;
 298 }
 299
 300 bool wxPen::IsFree() const
 301 {
 302   return (M_PENDATA && M_PENDATA->m_hPen == 0);
 303 }
 304
 305 void wxPen::Unshare()
 306 {
 307         // Don't change shared data
 308         if (!m_refData)
 309     {
 310                 m_refData = new wxPenRefData();
 311         }
 312     else
 313     {
 314                 wxPenRefData* ref = new wxPenRefData(*(wxPenRefData*)m_refData);
 315                 UnRef();
 316                 m_refData = ref;
 317         }
 318 }
 319
 320 void wxPen::SetColour(const wxColour& col)
 321 {
 322     Unshare();
 323
 324     M_PENDATA->m_colour = col;
 325
 326     RealizeResource();
 327 }
 328
 329 void wxPen::SetColour(unsigned char r, unsigned char g, unsigned char b)
 330 {
 331     Unshare();
 332
 333     M_PENDATA->m_colour.Set(r, g, b);
 334
 335     RealizeResource();
 336 }
 337
 338 void wxPen::SetWidth(int Width)
 339 {
 340     Unshare();
 341
 342     M_PENDATA->m_width = Width;
 343
 344     RealizeResource();
 345 }
 346
 347 void wxPen::SetStyle(int Style)
 348 {
 349     Unshare();
 350
 351     M_PENDATA->m_style = Style;
 352
 353     RealizeResource();
 354 }
 355
 356 void wxPen::SetStipple(const wxBitmap& Stipple)
 357 {
 358     Unshare();
 359
 360     M_PENDATA->m_stipple = Stipple;
 361     M_PENDATA->m_style = wxSTIPPLE;
 362
 363     RealizeResource();
 364 }
 365
 366 void wxPen::SetDashes(int nb_dashes, const wxDash *Dash)
 367 {
 368     Unshare();
 369
 370     M_PENDATA->m_nbDash = nb_dashes;
 371     M_PENDATA->m_dash = (wxDash *)Dash;
 372
 373     RealizeResource();
 374 }
 375
 376 void wxPen::SetJoin(int Join)
 377 {
 378     Unshare();
 379
 380     M_PENDATA->m_join = Join;
 381
 382     RealizeResource();
 383 }
 384
 385 void wxPen::SetCap(int Cap)
 386 {
 387     Unshare();
 388
 389     M_PENDATA->m_cap = Cap;
 390
 391     RealizeResource();
 392 }
 393
 394 int wx2msPenStyle(int wx_style)
 395 {
 396     int cstyle;
 397     switch (wx_style)
 398     {
 399 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 400        case wxDOT:
 401            cstyle = PS_DOT;
 402            break;
 403
 404        case wxDOT_DASH:
 405            cstyle = PS_DASHDOT;
 406            break;
 407
 408        case wxSHORT_DASH:
 409        case wxLONG_DASH:
 410            cstyle = PS_DASH;
 411            break;
 412
 413        case wxTRANSPARENT:
 414            cstyle = PS_NULL;
 415            break;
 416 #endif
 417
 418        case wxUSER_DASH:
 419 #if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
 420 #ifdef __WIN32__
 421            // Win32s doesn't have PS_USERSTYLE
 422            if (wxGetOsVersion()==wxWINDOWS_NT || wxGetOsVersion()==wxWIN95)
 423                cstyle = PS_USERSTYLE;
 424            else
 425                cstyle = PS_DOT; // We must make a choice... This is mine!
 426 #else
 427            cstyle = PS_DASH;
 428 #endif
 429 #endif
 430            break;
 431        case wxSOLID:
 432        default:
 433            cstyle = PS_SOLID;
 434            break;
 435    }
 436    return cstyle;
 437 }
 438