Rename GetGraphics to AcquireGraphics

Currently there are a number of classes that have a function called
GetGraphics(). It returns a SalGraphics instance if one is available
for the sole use of the caller. Some variants keep a pool of available
SalGraphics and return one not currently in use by anyone, creating
extra ones on demand, sometimes up to a set limit and returning NULL
on reaching that limit of simultaneously in use SalGraphics.

This is confusing. What is really happening from the perspective of the calling
is that is that we are attempting to *acquire* ownership of a SalGraphics
instance.

Therefore, rename GetGraphics to AcquireGraphics() which returns a handle to a
SalGraphics if we can acquire a free graphics instance, and NULL if we cannot,
which makes it cleared that ReleaseGraphics should be called on the result
of AcquireGraphics.

The classes that were changed to include the new acquire function are:

* SalFrame
* SalVirtualDevice
* SalInfoPrinter
* PspSalInfoPrinter
* X11SalFrame
* X11SalVirtualDevice
* GtkSalFrame
* KDESalFrame
* TDESalFrame
* WinSalFrame
* WinSalInfoPrinter
* WinSalVirtualDevice
* SvpSalFrame
* SvpSalVirtualDevice
* AquaSalFrame
* AquaSalInfoPrinter
* AquaSalVirtualDevice

Change-Id: Ic39c08a4bcaf665ae08ba2808cd03b0e80790c46
Reviewed-on: https://gerrit.libreoffice.org/8070
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
Tested-by: Caolán McNamara <caolanm@redhat.com>

17 files changed, 17 insertions, 17 deletions

diff --git a/vcl/inc/generic/genprn.h b/vcl/inc/generic/genprn.h
index a14a46a501cd..d21b97e19c5a 100644
--- a/vcl/inc/generic/genprn.h
+++ b/vcl/inc/generic/genprn.h
@@ -38,7 +38,7 @@ public:
     virtual ~PspSalInfoPrinter();
 
     // overload all pure virtual methods
-    virtual SalGraphics*            GetGraphics();
+    virtual SalGraphics*            AcquireGraphics();
     virtual void                    ReleaseGraphics( SalGraphics* pGraphics );
     virtual bool                    Setup( SalFrame* pFrame, ImplJobSetup* pSetupData );
     virtual bool                    SetPrinterData( ImplJobSetup* pSetupData );
diff --git a/vcl/inc/headless/svpframe.hxx b/vcl/inc/headless/svpframe.hxx
index 8e72709b979f..b05f71e71078 100644
--- a/vcl/inc/headless/svpframe.hxx
+++ b/vcl/inc/headless/svpframe.hxx
@@ -76,7 +76,7 @@ public:
 #endif
 
     // SalFrame
-    virtual SalGraphics*        GetGraphics();
+    virtual SalGraphics*        AcquireGraphics();
     virtual void                ReleaseGraphics( SalGraphics* pGraphics );
 
     virtual bool                PostEvent( void* pData );
diff --git a/vcl/inc/headless/svpvd.hxx b/vcl/inc/headless/svpvd.hxx
index a896db8300d4..1f0376ecc196 100644
--- a/vcl/inc/headless/svpvd.hxx
+++ b/vcl/inc/headless/svpvd.hxx
@@ -41,7 +41,7 @@ public:
     virtual ~SvpSalVirtualDevice();
 
     // SalVirtualDevice
-    virtual SalGraphics*    GetGraphics();
+    virtual SalGraphics*    AcquireGraphics();
     virtual void            ReleaseGraphics( SalGraphics* pGraphics );
 
     virtual bool        SetSize( long nNewDX, long nNewDY );
diff --git a/vcl/inc/osx/salframe.h b/vcl/inc/osx/salframe.h
index ff7c97295c71..7feac6e404e6 100644
--- a/vcl/inc/osx/salframe.h
+++ b/vcl/inc/osx/salframe.h
@@ -112,7 +112,7 @@ public:
 
     virtual ~AquaSalFrame();
 
-    virtual SalGraphics*        GetGraphics() SAL_OVERRIDE;
+    virtual SalGraphics*        AcquireGraphics() SAL_OVERRIDE;
     virtual void                ReleaseGraphics( SalGraphics* pGraphics ) SAL_OVERRIDE;
     virtual bool                PostEvent( void* pData ) SAL_OVERRIDE;
     virtual void                SetTitle( const OUString& rTitle ) SAL_OVERRIDE;
diff --git a/vcl/inc/osx/salprn.h b/vcl/inc/osx/salprn.h
index 4a1cdb325ed9..3aa17becf245 100644
--- a/vcl/inc/osx/salprn.h
+++ b/vcl/inc/osx/salprn.h
@@ -71,7 +71,7 @@ class AquaSalInfoPrinter : public SalInfoPrinter
 
     void                        SetupPrinterGraphics( CGContextRef i_xContext ) const;
 
-    virtual SalGraphics*        GetGraphics() SAL_OVERRIDE;
+    virtual SalGraphics*        AcquireGraphics() SAL_OVERRIDE;
     virtual void                ReleaseGraphics( SalGraphics* i_pGraphics ) SAL_OVERRIDE;
     virtual bool                Setup( SalFrame* i_pFrame, ImplJobSetup* i_pSetupData ) SAL_OVERRIDE;
     virtual bool                SetPrinterData( ImplJobSetup* pSetupData ) SAL_OVERRIDE;
diff --git a/vcl/inc/quartz/salvd.h b/vcl/inc/quartz/salvd.h
index dc17534bf197..beec9891bde5 100644
--- a/vcl/inc/quartz/salvd.h
+++ b/vcl/inc/quartz/salvd.h
@@ -58,7 +58,7 @@ public:
     AquaSalVirtualDevice( AquaSalGraphics* pGraphic, long nDX, long nDY, sal_uInt16 nBitCount, const SystemGraphicsData *pData );
     virtual ~AquaSalVirtualDevice();
 
-    virtual SalGraphics*            GetGraphics();
+    virtual SalGraphics*            AcquireGraphics();
     virtual void                    ReleaseGraphics( SalGraphics* pGraphics );
     virtual bool                    SetSize( long nNewDX, long nNewDY );
     virtual void                       GetSize( long& rWidth, long& rHeight );
diff --git a/vcl/inc/salframe.hxx b/vcl/inc/salframe.hxx
index 9142e7aee7f3..87ee9419f6eb 100644
--- a/vcl/inc/salframe.hxx
+++ b/vcl/inc/salframe.hxx
@@ -110,7 +110,7 @@ public:
 
     // SalGraphics or NULL, but two Graphics for all SalFrames
     // must be returned
-    virtual SalGraphics*    GetGraphics() = 0;
+    virtual SalGraphics*    AcquireGraphics() = 0;
     virtual void            ReleaseGraphics( SalGraphics* pGraphics ) = 0;
 
     // Event must be destroyed, when Frame is destroyed
diff --git a/vcl/inc/salprn.hxx b/vcl/inc/salprn.hxx
index 368ec3d0c71e..a9a80701c032 100644
--- a/vcl/inc/salprn.hxx
+++ b/vcl/inc/salprn.hxx
@@ -58,7 +58,7 @@ public:
 
     // SalGraphics or NULL, but two Graphics for all SalFrames
     // must be returned
-    virtual SalGraphics*            GetGraphics() = 0;
+    virtual SalGraphics*            AcquireGraphics() = 0;
     virtual void                    ReleaseGraphics( SalGraphics* pGraphics ) = 0;
 
     virtual bool                    Setup( SalFrame* pFrame, ImplJobSetup* pSetupData ) = 0;
diff --git a/vcl/inc/salvd.hxx b/vcl/inc/salvd.hxx
index 736ee06822a5..842429f4d8c3 100644
--- a/vcl/inc/salvd.hxx
+++ b/vcl/inc/salvd.hxx
@@ -33,7 +33,7 @@ public:
 
     // SalGraphics or NULL, but two Graphics for all SalVirtualDevices
     // must be returned
-    virtual SalGraphics*    GetGraphics() = 0;
+    virtual SalGraphics*    AcquireGraphics() = 0;
     virtual void            ReleaseGraphics( SalGraphics* pGraphics ) = 0;
 
     // Set new size, without saving the old contents
diff --git a/vcl/inc/unx/gtk/gtkframe.hxx b/vcl/inc/unx/gtk/gtkframe.hxx
index 82cee5d47804..76a8ec5f83b4 100644
--- a/vcl/inc/unx/gtk/gtkframe.hxx
+++ b/vcl/inc/unx/gtk/gtkframe.hxx
@@ -351,7 +351,7 @@ public:
 
     // SalGraphics or NULL, but two Graphics for all SalFrames
     // must be returned
-    virtual SalGraphics*        GetGraphics();
+    virtual SalGraphics*        AcquireGraphics();
     virtual void                ReleaseGraphics( SalGraphics* pGraphics );
 
     // Event must be destroyed, when Frame is destroyed
diff --git a/vcl/inc/unx/kde/kdedata.hxx b/vcl/inc/unx/kde/kdedata.hxx
index 0b8afea6d926..53537afd66db 100644
--- a/vcl/inc/unx/kde/kdedata.hxx
+++ b/vcl/inc/unx/kde/kdedata.hxx
@@ -62,7 +62,7 @@ public:
     KDESalFrame( SalFrame* pParent, sal_uLong );
     virtual ~KDESalFrame();
 
-    virtual SalGraphics* GetGraphics();
+    virtual SalGraphics* AcquireGraphics();
     virtual void ReleaseGraphics( SalGraphics *pGraphics );
     virtual void updateGraphics( bool bClear );
     virtual void UpdateSettings( AllSettings& rSettings );
diff --git a/vcl/inc/unx/salframe.h b/vcl/inc/unx/salframe.h
index e5f41264158d..931764170861 100644
--- a/vcl/inc/unx/salframe.h
+++ b/vcl/inc/unx/salframe.h
@@ -210,7 +210,7 @@ public:
     bool                    appendUnicodeSequence( sal_Unicode );
     bool                    endUnicodeSequence();
 
-    virtual SalGraphics*        GetGraphics();
+    virtual SalGraphics*        AcquireGraphics();
     virtual void                ReleaseGraphics( SalGraphics* pGraphics );
 
     // call with true to clear graphics (setting None as drawable)
diff --git a/vcl/inc/unx/salvd.h b/vcl/inc/unx/salvd.h
index b1210b3a5243..b50dd087dd39 100644
--- a/vcl/inc/unx/salvd.h
+++ b/vcl/inc/unx/salvd.h
@@ -76,7 +76,7 @@ public:
     int                     GetHeight() const { return nDY_; }
     SalX11Screen            GetXScreenNumber() const { return m_nXScreen; }
 
-    virtual SalGraphics*    GetGraphics();
+    virtual SalGraphics*    AcquireGraphics();
     virtual void            ReleaseGraphics( SalGraphics* pGraphics );
 
                             // Set new size, without saving the old contents
diff --git a/vcl/inc/unx/tde/tdedata.hxx b/vcl/inc/unx/tde/tdedata.hxx
index 940947b40c90..bc937765cb5f 100644
--- a/vcl/inc/unx/tde/tdedata.hxx
+++ b/vcl/inc/unx/tde/tdedata.hxx
@@ -72,7 +72,7 @@ public:
     TDESalFrame( SalFrame* pParent, sal_uLong );
     virtual ~TDESalFrame();
 
-    virtual SalGraphics* GetGraphics();
+    virtual SalGraphics* AcquireGraphics();
     virtual void ReleaseGraphics( SalGraphics *pGraphics );
     virtual void updateGraphics( bool bClear );
     virtual void UpdateSettings( AllSettings& rSettings );
diff --git a/vcl/inc/win/salframe.h b/vcl/inc/win/salframe.h
index 990d5bf290c0..526b87ab0b57 100644
--- a/vcl/inc/win/salframe.h
+++ b/vcl/inc/win/salframe.h
@@ -88,7 +88,7 @@ public:
     WinSalFrame();
     virtual ~WinSalFrame();
 
-    virtual SalGraphics*        GetGraphics();
+    virtual SalGraphics*        AcquireGraphics();
     virtual void                ReleaseGraphics( SalGraphics* pGraphics );
     virtual bool                PostEvent( void* pData );
     virtual void                SetTitle( const OUString& rTitle );
diff --git a/vcl/inc/win/salprn.h b/vcl/inc/win/salprn.h
index 2c71f7a28484..7c15d019de38 100644
--- a/vcl/inc/win/salprn.h
+++ b/vcl/inc/win/salprn.h
@@ -59,7 +59,7 @@ public:
     WinSalInfoPrinter();
     virtual ~WinSalInfoPrinter();
 
-    virtual SalGraphics*            GetGraphics();
+    virtual SalGraphics*            AcquireGraphics();
     virtual void                    ReleaseGraphics( SalGraphics* pGraphics );
     virtual bool                    Setup( SalFrame* pFrame, ImplJobSetup* pSetupData );
     virtual bool                    SetPrinterData( ImplJobSetup* pSetupData );
diff --git a/vcl/inc/win/salvd.h b/vcl/inc/win/salvd.h
index b8c6f555fc29..3c7d3e998e52 100644
--- a/vcl/inc/win/salvd.h
+++ b/vcl/inc/win/salvd.h
@@ -49,7 +49,7 @@ public:
     WinSalVirtualDevice();
     virtual ~WinSalVirtualDevice();
 
-    virtual SalGraphics*            GetGraphics();
+    virtual SalGraphics*            AcquireGraphics();
     virtual void                    ReleaseGraphics( SalGraphics* pGraphics );
     virtual bool                    SetSize( long nNewDX, long nNewDY );
     virtual void                    GetSize( long& rWidth, long& rHeight );