]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/dcgraph.cpp
Add wxWithImages helper mix-in with {Set,Get,Assign}ImageList() methods.
[wxWidgets.git] / src / common / dcgraph.cpp
index 96516c4e5234baa3e89cb78affe88ac7c64546c3..1f7295a12ec61804252379364e95f12f54f0fee9 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        src/common/graphcmn.cpp
+// Name:        src/common/dcgraph.cpp
 // Purpose:     graphics context methods common to all platforms
 // Author:      Stefan Csomor
 // Modified by:
@@ -30,7 +30,7 @@
 
 #include "wx/dcclient.h"
 
-#ifdef __WXOSX__
+#ifdef __WXOSX_OR_COCOA__
 #ifdef __WXOSX_IPHONE__
     #include <CoreGraphics/CoreGraphics.h>
 #else
@@ -53,6 +53,44 @@ static inline double DegToRad(double deg)
     return (deg * M_PI) / 180.0;
 }
 
+static wxCompositionMode TranslateRasterOp(wxRasterOperationMode function)
+{
+    switch ( function )
+    {
+        case wxCOPY: // src
+            // since we are supporting alpha, _OVER is closer to the intention than _SOURCE
+            // since the latter would overwrite even when alpha is not set to opaque
+            return wxCOMPOSITION_OVER;
+
+        case wxOR:         // src OR dst
+            return wxCOMPOSITION_ADD;
+
+        case wxNO_OP:      // dst
+            return wxCOMPOSITION_DEST; // ignore the source
+
+        case wxCLEAR:      // 0
+            return wxCOMPOSITION_CLEAR;// clear dst
+
+        case wxXOR:        // src XOR dst
+            return wxCOMPOSITION_XOR;
+
+        case wxAND:        // src AND dst
+        case wxAND_INVERT: // (NOT src) AND dst
+        case wxAND_REVERSE:// src AND (NOT dst)
+        case wxEQUIV:      // (NOT src) XOR dst
+        case wxINVERT:     // NOT dst
+        case wxNAND:       // (NOT src) OR (NOT dst)
+        case wxNOR:        // (NOT src) AND (NOT dst)
+        case wxOR_INVERT:  // (NOT src) OR dst
+        case wxOR_REVERSE: // src OR (NOT dst)
+        case wxSET:        // 1
+        case wxSRC_INVERT: // NOT src
+            break;
+    }
+
+    return wxCOMPOSITION_INVALID;
+}
+
 //-----------------------------------------------------------------------------
 // wxDC bridge class
 //-----------------------------------------------------------------------------
@@ -69,10 +107,19 @@ wxGCDC::wxGCDC( const wxMemoryDC& dc) :
 {
 }
 
+#if wxUSE_PRINTING_ARCHITECTURE
 wxGCDC::wxGCDC( const wxPrinterDC& dc) :
   wxDC( new wxGCDCImpl( this, dc ) )
 {
 }
+#endif
+
+#if defined(__WXMSW__) && wxUSE_ENH_METAFILE
+wxGCDC::wxGCDC(const wxEnhMetaFileDC& dc)
+   : wxDC(new wxGCDCImpl(this, dc))
+{
+}
+#endif
 
 wxGCDC::wxGCDC() :
   wxDC( new wxGCDCImpl( this ) )
@@ -83,7 +130,7 @@ wxGCDC::~wxGCDC()
 {
 }
 
-wxGraphicsContext* wxGCDC::GetGraphicsContext()
+wxGraphicsContext* wxGCDC::GetGraphicsContext() const
 {
     if (!m_pimpl) return NULL;
     wxGCDCImpl *gc_impl = (wxGCDCImpl*) m_pimpl;
@@ -133,15 +180,34 @@ wxGCDCImpl::wxGCDCImpl( wxDC *owner, const wxMemoryDC& dc ) :
    wxDCImpl( owner )
 {
     Init();
-    SetGraphicsContext( wxGraphicsContext::Create(dc) );
+    wxGraphicsContext* context;
+#if wxUSE_CAIRO
+    wxGraphicsRenderer* renderer = wxGraphicsRenderer::GetCairoRenderer();
+    context = renderer->CreateContext(dc);
+#else
+    context = wxGraphicsContext::Create(dc);
+#endif
+
+    SetGraphicsContext( context );
 }
 
+#if wxUSE_PRINTING_ARCHITECTURE
 wxGCDCImpl::wxGCDCImpl( wxDC *owner, const wxPrinterDC& dc ) :
    wxDCImpl( owner )
 {
     Init();
     SetGraphicsContext( wxGraphicsContext::Create(dc) );
 }
+#endif
+
+#if defined(__WXMSW__) && wxUSE_ENH_METAFILE
+wxGCDCImpl::wxGCDCImpl(wxDC *owner, const wxEnhMetaFileDC& dc)
+   : wxDCImpl(owner)
+{
+    Init();
+    SetGraphicsContext(wxGraphicsContext::Create(dc));
+}
+#endif
 
 void wxGCDCImpl::Init()
 {
@@ -154,7 +220,7 @@ void wxGCDCImpl::Init()
     m_font = *wxNORMAL_FONT;
     m_brush = *wxWHITE_BRUSH;
 
-    m_graphicContext = NULL;
+    m_graphicContext = wxGraphicsContext::Create();
     m_logicalFunctionSupported = true;
 }
 
@@ -164,23 +230,34 @@ wxGCDCImpl::~wxGCDCImpl()
     delete m_graphicContext;
 }
 
-void wxGCDCImpl::DoDrawBitmap( const wxBitmap &bmp, wxCoord x, wxCoord y, bool WXUNUSED(useMask) )
+void wxGCDCImpl::DoDrawBitmap( const wxBitmap &bmp, wxCoord x, wxCoord y,
+                               bool useMask )
 {
     wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoDrawBitmap - invalid DC") );
     wxCHECK_RET( bmp.IsOk(), wxT("wxGCDC(cg)::DoDrawBitmap - invalid bitmap") );
 
+    int w = bmp.GetWidth();
+    int h = bmp.GetHeight();
     if ( bmp.GetDepth() == 1 )
     {
         m_graphicContext->SetPen(*wxTRANSPARENT_PEN);
         m_graphicContext->SetBrush( wxBrush( m_textBackgroundColour , wxSOLID ) );
-        m_graphicContext->DrawRectangle( x , y , bmp.GetWidth() , bmp.GetHeight() );
+        m_graphicContext->DrawRectangle( x, y, w, h );
         m_graphicContext->SetBrush( wxBrush( m_textForegroundColour , wxSOLID ) );
-        m_graphicContext->DrawBitmap( bmp, x , y , bmp.GetWidth() , bmp.GetHeight() );
+        m_graphicContext->DrawBitmap( bmp, x, y, w, h );
         m_graphicContext->SetBrush( m_graphicContext->CreateBrush(m_brush));
         m_graphicContext->SetPen( m_graphicContext->CreatePen(m_pen));
     }
-    else
-        m_graphicContext->DrawBitmap( bmp, x , y , bmp.GetWidth() , bmp.GetHeight() );
+    else // not a monochrome bitmap, handle it normally
+    {
+        // make a copy in case we need to remove its mask, if we don't modify
+        // it the copy is cheap as bitmaps are reference-counted
+        wxBitmap bmpCopy(bmp);
+        if ( !useMask && bmp.GetMask() )
+            bmpCopy.SetMask(NULL);
+
+        m_graphicContext->DrawBitmap( bmpCopy, x, y, w, h );
+    }
 }
 
 void wxGCDCImpl::DoDrawIcon( const wxIcon &icon, wxCoord x, wxCoord y )
@@ -213,9 +290,7 @@ void wxGCDCImpl::EndPage()
 
 void wxGCDCImpl::Flush()
 {
-#ifdef __WXOSX__
-    CGContextFlush( (CGContextRef) m_graphicContext->GetNativeContext() );
-#endif
+    m_graphicContext->Flush();
 }
 
 void wxGCDCImpl::DoSetClippingRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h )
@@ -281,7 +356,7 @@ void wxGCDCImpl::DestroyClippingRegion()
 {
     m_graphicContext->ResetClip();
     // currently the clip eg of a window extends to the area between the scrollbars
-    // so we must explicitely make sure it only covers the area we want it to draw
+    // so we must explicitly make sure it only covers the area we want it to draw
     int width, height ;
     GetOwner()->GetSize( &width , &height ) ;
     m_graphicContext->Clip( DeviceToLogicalX(0) , DeviceToLogicalY(0) , DeviceToLogicalXRel(width), DeviceToLogicalYRel(height) );
@@ -321,7 +396,7 @@ void wxGCDCImpl::SetTextBackground( const wxColour &col )
     m_textBackgroundColour = col;
 }
 
-void wxGCDCImpl::SetMapMode( int mode )
+void wxGCDCImpl::SetMapMode( wxMappingMode mode )
 {
     switch (mode)
     {
@@ -367,13 +442,13 @@ void wxGCDCImpl::ComputeScaleAndOrigin()
     if ( m_graphicContext )
     {
         m_matrixCurrent = m_graphicContext->CreateMatrix();
-        
+
         // the logical origin sets the origin to have new coordinates
-        m_matrixCurrent.Translate( m_deviceOriginX - m_logicalOriginX * m_signX * m_scaleX, 
+        m_matrixCurrent.Translate( m_deviceOriginX - m_logicalOriginX * m_signX * m_scaleX,
                                    m_deviceOriginY-m_logicalOriginY * m_signY * m_scaleY);
-        
+
         m_matrixCurrent.Scale( m_scaleX * m_signX, m_scaleY * m_signY );
-        
+
         m_graphicContext->SetTransform( m_matrixOriginal );
         m_graphicContext->ConcatTransform( m_matrixCurrent );
     }
@@ -435,20 +510,27 @@ void wxGCDCImpl::SetBackground( const wxBrush &brush )
         return;
 }
 
-void wxGCDCImpl::SetLogicalFunction( int function )
+void wxGCDCImpl::SetLogicalFunction( wxRasterOperationMode function )
 {
     if (m_logicalFunction == function)
         return;
 
     m_logicalFunction = function;
-    if ( m_graphicContext->SetLogicalFunction( function ) )
-        m_logicalFunctionSupported=true;
+
+    wxCompositionMode mode = TranslateRasterOp( function );
+    m_logicalFunctionSupported = mode != wxCOMPOSITION_INVALID;
+    if (m_logicalFunctionSupported)
+        m_logicalFunctionSupported = m_graphicContext->SetCompositionMode(mode);
+
+    if ( function == wxXOR )
+        m_graphicContext->SetAntialiasMode(wxANTIALIAS_NONE);
     else
-        m_logicalFunctionSupported=false;
+        m_graphicContext->SetAntialiasMode(wxANTIALIAS_DEFAULT);
 }
 
 bool wxGCDCImpl::DoFloodFill(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
-                         const wxColour& WXUNUSED(col), int WXUNUSED(style))
+                             const wxColour& WXUNUSED(col),
+                             wxFloodFillStyle WXUNUSED(style))
 {
     return false;
 }
@@ -610,7 +692,7 @@ void wxGCDCImpl::DoDrawSpline(const wxPointList *points)
     wxGraphicsPath path = m_graphicContext->CreatePath();
 
     wxPointList::compatibility_iterator node = points->GetFirst();
-    if (node == wxPointList::compatibility_iterator())
+    if ( !node )
         // empty list
         return;
 
@@ -629,13 +711,13 @@ void wxGCDCImpl::DoDrawSpline(const wxPointList *points)
 
     path.MoveToPoint( x1 , y1 );
     path.AddLineToPoint( cx1 , cy1 );
-#if !wxUSE_STL
+#if !wxUSE_STD_CONTAINERS
 
     while ((node = node->GetNext()) != NULL)
 #else
 
     while ((node = node->GetNext()))
-#endif // !wxUSE_STL
+#endif // !wxUSE_STD_CONTAINERS
 
     {
         p = node->GetData();
@@ -659,8 +741,8 @@ void wxGCDCImpl::DoDrawSpline(const wxPointList *points)
 #endif // wxUSE_SPLINES
 
 void wxGCDCImpl::DoDrawPolygon( int n, wxPoint points[],
-                            wxCoord xoffset, wxCoord yoffset,
-                            int fillStyle )
+                                wxCoord xoffset, wxCoord yoffset,
+                                wxPolygonFillMode fillStyle )
 {
     wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoDrawPolygon - invalid DC") );
 
@@ -691,7 +773,7 @@ void wxGCDCImpl::DoDrawPolyPolygon(int n,
                                wxPoint points[],
                                wxCoord xoffset,
                                wxCoord yoffset,
-                               int fillStyle)
+                               wxPolygonFillMode fillStyle)
 {
     wxASSERT(n > 1);
     wxGraphicsPath path = m_graphicContext->CreatePath();
@@ -786,7 +868,8 @@ bool wxGCDCImpl::CanDrawBitmap() const
 
 bool wxGCDCImpl::DoBlit(
     wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
-    wxDC *source, wxCoord xsrc, wxCoord ysrc, int logical_func , bool useMask,
+    wxDC *source, wxCoord xsrc, wxCoord ysrc,
+    wxRasterOperationMode logical_func , bool useMask,
     wxCoord xsrcMask, wxCoord ysrcMask )
 {
     return DoStretchBlit( xdest, ydest, width, height,
@@ -797,7 +880,7 @@ bool wxGCDCImpl::DoBlit(
 bool wxGCDCImpl::DoStretchBlit(
     wxCoord xdest, wxCoord ydest, wxCoord dstWidth, wxCoord dstHeight,
     wxDC *source, wxCoord xsrc, wxCoord ysrc, wxCoord srcWidth, wxCoord srcHeight,
-    int logical_func , bool WXUNUSED(useMask),
+    wxRasterOperationMode logical_func , bool useMask,
     wxCoord xsrcMask, wxCoord ysrcMask )
 {
     wxCHECK_MSG( IsOk(), false, wxT("wxGCDC(cg)::DoStretchBlit - invalid DC") );
@@ -805,51 +888,67 @@ bool wxGCDCImpl::DoStretchBlit(
 
     if ( logical_func == wxNO_OP )
         return true;
-    else if ( !m_graphicContext->SetLogicalFunction( logical_func ) )
 
+    wxCompositionMode mode = TranslateRasterOp(logical_func);
+    if ( mode == wxCOMPOSITION_INVALID )
     {
-        wxFAIL_MSG( wxT("Blitting is only supported with wxCOPY logical operation.") );
+        wxFAIL_MSG( wxT("Blitting is not supported with this logical operation.") );
         return false;
     }
 
-    if (xsrcMask == -1 && ysrcMask == -1)
-    {
-        xsrcMask = xsrc;
-        ysrcMask = ysrc;
-    }
-
     wxRect subrect(source->LogicalToDeviceX(xsrc),
                    source->LogicalToDeviceY(ysrc),
                    source->LogicalToDeviceXRel(srcWidth),
                    source->LogicalToDeviceYRel(srcHeight));
+    // clip the subrect down to the size of the source DC
+    wxRect clip;
+    source->GetSize(&clip.width, &clip.height);
+    subrect.Intersect(clip);
+    if (subrect.width == 0)
+        return true;
 
-    // if needed clip the subrect down to the size of the source DC
-    wxCoord sw, sh;
-    source->GetSize(&sw, &sh);
-    sw = source->LogicalToDeviceXRel(sw);
-    sh = source->LogicalToDeviceYRel(sh);
-    if (subrect.x + subrect.width > sw)
-        subrect.width = sw - subrect.x;
-    if (subrect.y + subrect.height > sh)
-        subrect.height = sh - subrect.y;
-
-    wxBitmap blit = source->GetAsBitmap( &subrect );
+    bool retval = true;
 
-    if ( blit.IsOk() )
-    {
-        m_graphicContext->DrawBitmap( blit, xdest, ydest,
-                                      dstWidth, dstHeight);
-    }
-    else
+    wxCompositionMode formerMode = m_graphicContext->GetCompositionMode();
+    if (m_graphicContext->SetCompositionMode(mode))
     {
-        wxFAIL_MSG( wxT("Cannot Blit. Unable to get contents of DC as bitmap.") );
-        return false;
-    }
+        wxAntialiasMode formerAa = m_graphicContext->GetAntialiasMode();
+        if (mode == wxCOMPOSITION_XOR)
+        {
+            m_graphicContext->SetAntialiasMode(wxANTIALIAS_NONE);
+        }
 
-    // reset logical function
-    m_graphicContext->SetLogicalFunction( m_logicalFunction );
+        if (xsrcMask == -1 && ysrcMask == -1)
+        {
+            xsrcMask = xsrc;
+            ysrcMask = ysrc;
+        }
 
-    return true;
+        wxBitmap blit = source->GetAsBitmap( &subrect );
+
+        if ( blit.IsOk() )
+        {
+            if ( !useMask && blit.GetMask() )
+                blit.SetMask(NULL);
+
+            m_graphicContext->DrawBitmap( blit, xdest, ydest,
+                                          dstWidth, dstHeight);
+        }
+        else
+        {
+            wxFAIL_MSG( wxT("Cannot Blit. Unable to get contents of DC as bitmap.") );
+            retval = false;
+        }
+
+        if (mode == wxCOMPOSITION_XOR)
+        {
+            m_graphicContext->SetAntialiasMode(formerAa);
+        }
+    }
+    // reset composition
+    m_graphicContext->SetCompositionMode(formerMode);
+
+    return retval;
 }
 
 void wxGCDCImpl::DoDrawRotatedText(const wxString& str, wxCoord x, wxCoord y,
@@ -857,7 +956,7 @@ void wxGCDCImpl::DoDrawRotatedText(const wxString& str, wxCoord x, wxCoord y,
 {
     wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoDrawRotatedText - invalid DC") );
 
-    if ( str.length() == 0 )
+    if ( str.empty() )
         return;
     if ( !m_logicalFunctionSupported )
         return;
@@ -870,9 +969,21 @@ void wxGCDCImpl::DoDrawRotatedText(const wxString& str, wxCoord x, wxCoord y,
 
 void wxGCDCImpl::DoDrawText(const wxString& str, wxCoord x, wxCoord y)
 {
-    wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoDrawRotatedText - invalid DC") );
+    // For compatibility with other ports (notably wxGTK) and because it's
+    // genuinely useful, we allow passing multiline strings to DrawText().
+    // However there is no native OSX function to draw them directly so we
+    // instead reuse the generic DrawLabel() method to render them. Of course,
+    // DrawLabel() itself will call back to us but with single line strings
+    // only so there won't be any infinite recursion here.
+    if ( str.find('\n') != wxString::npos )
+    {
+        GetOwner()->DrawLabel(str, wxRect(x, y, 0, 0));
+        return;
+    }
+
+    wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoDrawText - invalid DC") );
 
-    if ( str.length() == 0 )
+    if ( str.empty() )
         return;
 
     if ( !m_logicalFunctionSupported )
@@ -895,7 +1006,7 @@ void wxGCDCImpl::DoGetTextExtent( const wxString &str, wxCoord *width, wxCoord *
                               wxCoord *descent, wxCoord *externalLeading ,
                               const wxFont *theFont ) const
 {
-    wxCHECK_RET( IsOk(), wxT("wxGCDC(cg)::DoGetTextExtent - invalid DC") );
+    wxCHECK_RET( m_graphicContext, wxT("wxGCDC(cg)::DoGetTextExtent - invalid DC") );
 
     if ( theFont )
     {
@@ -923,7 +1034,7 @@ void wxGCDCImpl::DoGetTextExtent( const wxString &str, wxCoord *width, wxCoord *
 
 bool wxGCDCImpl::DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const
 {
-    wxCHECK_MSG( IsOk(), false, wxT("wxGCDC(cg)::DoGetPartialTextExtents - invalid DC") );
+    wxCHECK_MSG( m_graphicContext, false, wxT("wxGCDC(cg)::DoGetPartialTextExtents - invalid DC") );
     widths.Clear();
     widths.Add(0,text.Length());
     if ( text.IsEmpty() )
@@ -961,7 +1072,10 @@ void wxGCDCImpl::Clear(void)
     m_graphicContext->SetBrush( m_backgroundBrush );
     wxPen p = *wxTRANSPARENT_PEN;
     m_graphicContext->SetPen( p );
+    wxCompositionMode formerMode = m_graphicContext->GetCompositionMode();
+    m_graphicContext->SetCompositionMode(wxCOMPOSITION_SOURCE);
     DoDrawRectangle( 0, 0, 32000 , 32000 );
+    m_graphicContext->SetCompositionMode(formerMode);
     m_graphicContext->SetPen( m_pen );
     m_graphicContext->SetBrush( m_brush );
 }
@@ -1054,4 +1168,21 @@ void wxGCDCImpl::DoDrawCheckMark(wxCoord x, wxCoord y,
     wxDCImpl::DoDrawCheckMark(x,y,width,height);
 }
 
+#ifdef __WXMSW__
+wxRect wxGCDCImpl::MSWApplyGDIPlusTransform(const wxRect& r) const
+{
+    wxGraphicsContext* const gc = GetGraphicsContext();
+    wxCHECK_MSG( gc, r, wxT("Invalid wxGCDC") );
+
+    double x = 0,
+           y = 0;
+    gc->GetTransform().TransformPoint(&x, &y);
+
+    wxRect rect(r);
+    rect.Offset(x, y);
+
+    return rect;
+}
+#endif // __WXMSW__
+
 #endif // wxUSE_GRAPHICS_CONTEXT