1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef FORMS_WINDOWSTATEGUARD_HXX 25*b1cdbd2cSJim Jagielski #define FORMS_WINDOWSTATEGUARD_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 28*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/XWindow2.hpp> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/XControlModel.hpp> 30*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 31*b1cdbd2cSJim Jagielski #include <rtl/ref.hxx> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski //........................................................................ 34*b1cdbd2cSJim Jagielski namespace frm 35*b1cdbd2cSJim Jagielski { 36*b1cdbd2cSJim Jagielski //........................................................................ 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski //==================================================================== 39*b1cdbd2cSJim Jagielski //= WindowStateGuard 40*b1cdbd2cSJim Jagielski //==================================================================== 41*b1cdbd2cSJim Jagielski class WindowStateGuard_Impl; 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski /** a helper class which monitors certain states of an XWindow2, and ensures 44*b1cdbd2cSJim Jagielski that they're consistent with respective properties at an XModel. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski For form controls, window states - such as "Enabled" - can be set by various 47*b1cdbd2cSJim Jagielski means. You can set the respective control model property, you can directly manipulate 48*b1cdbd2cSJim Jagielski the XWindow2, or the state can change implicitly due to VCL actions. In any case, 49*b1cdbd2cSJim Jagielski we need to ensure that the state does not contradict the model property "too much". 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski As an example, consider a form control which, according to its model's property, is disabled. 52*b1cdbd2cSJim Jagielski Now when the parent VCL window of the control's VCL window is enabled, then the the control's 53*b1cdbd2cSJim Jagielski window is enabled, too - which contradicts the model property. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski A WindowStateGuard helps you preventing such inconsistent states. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski The class is not threadsafe. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski class WindowStateGuard 60*b1cdbd2cSJim Jagielski { 61*b1cdbd2cSJim Jagielski private: 62*b1cdbd2cSJim Jagielski ::rtl::Reference< WindowStateGuard_Impl > m_pImpl; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski public: 65*b1cdbd2cSJim Jagielski WindowStateGuard(); 66*b1cdbd2cSJim Jagielski ~WindowStateGuard(); 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski void attach( 69*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow2 >& _rxWindow, 70*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& _rxModel 71*b1cdbd2cSJim Jagielski ); 72*b1cdbd2cSJim Jagielski }; 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski //........................................................................ 75*b1cdbd2cSJim Jagielski } // namespace frm 76*b1cdbd2cSJim Jagielski //........................................................................ 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski #endif // FORMS_WINDOWSTATEGUARD_HXX 79*b1cdbd2cSJim Jagielski 80