tdf#97228 Moved class ControlCacheKey in a seperate include file.

class ControlCacheKey defined in include/vcl/salnativewidgets.hxx is used
only by vcl therefore it is moved to a seperate include file named
ControlCacheKey.hxx which is inside vcl/inc/ControlCacheKey.hxx.

This header file contains the definition of the the class ControlCacheKey.

Since this class uses an object of another class named Size which is
defined in gen.hxx therefore this is included in ControlCacheKey.hxx.

All the files that references the class ControlCacheKey includes
ControlCacheKey.hxx with the syntax: #include "ControlCacheKey.hxx"

Change-Id: I7d7b3e1cf6950a953e6bbed670c1914826b2bacd
Reviewed-on: https://gerrit.libreoffice.org/32422
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Michael Stahl <mstahl@redhat.com>

7 files changed, 85 insertions, 0 deletions

diff --git a/vcl/inc/ControlCacheKey.hxx b/vcl/inc/ControlCacheKey.hxx
new file mode 100644
index 000000000000..20baa6e3759b
--- /dev/null
+++ b/vcl/inc/ControlCacheKey.hxx
@@ -0,0 +1,79 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX
+#define INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX
+
+#include <tools/gen.hxx>
+#include <vcl/salnativewidgets.hxx>
+
+class ControlCacheKey
+{
+public:
+    ControlType mnType;
+    ControlPart mnPart;
+    ControlState mnState;
+    Size maSize;
+
+    ControlCacheKey(ControlType nType, ControlPart nPart, ControlState nState, const Size& rSize)
+        : mnType(nType)
+        , mnPart(nPart)
+        , mnState(nState)
+        , maSize(rSize)
+    {}
+
+    bool operator==(ControlCacheKey const& aOther) const
+    {
+        return mnType == aOther.mnType
+            && mnPart == aOther.mnPart
+            && mnState == aOther.mnState
+            && maSize.Width() == aOther.maSize.Width()
+            && maSize.Height() == aOther.maSize.Height();
+    }
+
+    bool canCacheControl()
+    {
+        switch(mnType)
+        {
+            case ControlType::Checkbox:
+            case ControlType::Radiobutton:
+            case ControlType::ListNode:
+            case ControlType::Slider:
+            case ControlType::Progress:
+            // FIXME: these guys have complex state hidden in ImplControlValue
+            // structs which affects rendering, needs to be a and needs to be
+            // part of the key to our cache.
+            case ControlType::Spinbox:
+            case ControlType::SpinButtons:
+            case ControlType::TabItem:
+                return false;
+
+            case ControlType::Menubar:
+                if (mnPart == ControlPart::Entire)
+                    return false;
+                break;
+
+            default:
+                break;
+        }
+        return true;
+    }
+};
+
+#endif // INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX
\ No newline at end of file
diff --git a/vcl/inc/opengl/win/gdiimpl.hxx b/vcl/inc/opengl/win/gdiimpl.hxx
index 1ea54be23dca..374d6ff42682 100644
--- a/vcl/inc/opengl/win/gdiimpl.hxx
+++ b/vcl/inc/opengl/win/gdiimpl.hxx
@@ -15,6 +15,7 @@
 #include "openglgdiimpl.hxx"
 #include "win/salgdi.h"
 #include <vcl/opengl/OpenGLContext.hxx>
+#include "ControlCacheKey.hxx"
 
 class WinOpenGLSalGraphicsImpl : public OpenGLSalGraphicsImpl
 {
diff --git a/vcl/inc/opengl/x11/gdiimpl.hxx b/vcl/inc/opengl/x11/gdiimpl.hxx
index 646b7a6aab26..9dacf6d20f0d 100644
--- a/vcl/inc/opengl/x11/gdiimpl.hxx
+++ b/vcl/inc/opengl/x11/gdiimpl.hxx
@@ -15,6 +15,7 @@
 #include "unx/salgdi.h"
 #include "unx/x11/x11gdiimpl.h"
 #include "openglgdiimpl.hxx"
+#include "ControlCacheKey.hxx"
 
 struct TextureCombo;
 
diff --git a/vcl/inc/svdata.hxx b/vcl/inc/svdata.hxx
index 813565165361..a8b3ccbf690a 100644
--- a/vcl/inc/svdata.hxx
+++ b/vcl/inc/svdata.hxx
@@ -37,6 +37,7 @@
 #include <list>
 #include <unordered_map>
 #include <boost/functional/hash.hpp>
+#include "ControlCacheKey.hxx"
 
 struct ImplPostEventData;
 struct ImplTimerData;
diff --git a/vcl/inc/unx/gtk/gtkgdi.hxx b/vcl/inc/unx/gtk/gtkgdi.hxx
index f780964c8694..23e423bb4c96 100644
--- a/vcl/inc/unx/gtk/gtkgdi.hxx
+++ b/vcl/inc/unx/gtk/gtkgdi.hxx
@@ -27,6 +27,7 @@
 #include <gdk/gdkkeysyms.h>
 
 #include <unx/gtk/gtkframe.hxx>
+#include "ControlCacheKey.hxx"
 
 #if GTK_CHECK_VERSION(3,0,0)
 
diff --git a/vcl/inc/unx/salgdi.h b/vcl/inc/unx/salgdi.h
index ef7ad2cb8f45..fb7d0fe6265a 100644
--- a/vcl/inc/unx/salgdi.h
+++ b/vcl/inc/unx/salgdi.h
@@ -34,6 +34,7 @@
 #include "salgeom.hxx"
 #include "sallayout.hxx"
 #include "vclpluginapi.h"
+#include "ControlCacheKey.hxx"
 
 #include <deque>
 #include <memory>
diff --git a/vcl/inc/unx/x11/x11gdiimpl.h b/vcl/inc/unx/x11/x11gdiimpl.h
index c5043646e422..9d91ad28f48c 100644
--- a/vcl/inc/unx/x11/x11gdiimpl.h
+++ b/vcl/inc/unx/x11/x11gdiimpl.h
@@ -11,6 +11,7 @@
 #define INCLUDED_VCL_INC_UNX_X11_X11GDIIMPL_HXX
 
 #include "unx/pixmap.hxx"
+#include "ControlCacheKey.hxx"
 
 class ControlCacheKey;