1 files changed, 70 insertions, 0 deletions
diff --git a/forms/source/inc/windowstateguard.hxx b/forms/source/inc/windowstateguard.hxx
new file mode 100644
index 000000000..f1a449c39
--- /dev/null
+++ b/forms/source/inc/windowstateguard.hxx
@@ -0,0 +1,70 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <com/sun/star/awt/XWindow2.hpp>
+#include <com/sun/star/awt/XControlModel.hpp>
+#include <rtl/ref.hxx>
+
+
+namespace frm
+{
+
+
+    //= WindowStateGuard
+
+    class WindowStateGuard_Impl;
+
+    /** a helper class which monitors certain states of an XWindow2, and ensures
+        that they're consistent with respective properties at an XModel.
+
+        For form controls, window states - such as "Enabled" - can be set by various
+        means. You can set the respective control model property, you can directly manipulate
+        the XWindow2, or the state can change implicitly due to VCL actions. In any case,
+        we need to ensure that the state does not contradict the model property "too much".
+
+        As an example, consider a form control which, according to its model's property, is disabled.
+        Now when the parent VCL window of the control's VCL window is enabled, then the control's
+        window is enabled, too - which contradicts the model property.
+
+        A WindowStateGuard helps you preventing such inconsistent states.
+
+        The class is not threadsafe.
+    */
+    class WindowStateGuard
+    {
+    private:
+        ::rtl::Reference< WindowStateGuard_Impl >   m_pImpl;
+
+    public:
+        WindowStateGuard();
+        ~WindowStateGuard();
+
+        void    attach(
+            const css::uno::Reference< css::awt::XWindow2 >& _rxWindow,
+            const css::uno::Reference< css::awt::XControlModel >& _rxModel
+        );
+    };
+
+
+} // namespace frm
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */