1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef FORMS_WINDOWSTATEGUARD_HXX 29*cdf0e10cSrcweir #define FORMS_WINDOWSTATEGUARD_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir /** === begin UNO includes === **/ 32*cdf0e10cSrcweir #include <com/sun/star/awt/XWindow2.hpp> 33*cdf0e10cSrcweir #include <com/sun/star/awt/XControlModel.hpp> 34*cdf0e10cSrcweir /** === end UNO includes === **/ 35*cdf0e10cSrcweir #include <rtl/ref.hxx> 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir //........................................................................ 38*cdf0e10cSrcweir namespace frm 39*cdf0e10cSrcweir { 40*cdf0e10cSrcweir //........................................................................ 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir //==================================================================== 43*cdf0e10cSrcweir //= WindowStateGuard 44*cdf0e10cSrcweir //==================================================================== 45*cdf0e10cSrcweir class WindowStateGuard_Impl; 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir /** a helper class which monitors certain states of an XWindow2, and ensures 48*cdf0e10cSrcweir that they're consistent with respective properties at an XModel. 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir For form controls, window states - such as "Enabled" - can be set by various 51*cdf0e10cSrcweir means. You can set the respective control model property, you can directly manipulate 52*cdf0e10cSrcweir the XWindow2, or the state can change implicitly due to VCL actions. In any case, 53*cdf0e10cSrcweir we need to ensure that the state does not contradict the model property "too much". 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir As an example, consider a form control which, according to its model's property, is disabled. 56*cdf0e10cSrcweir Now when the parent VCL window of the control's VCL window is enabled, then the the control's 57*cdf0e10cSrcweir window is enabled, too - which contradicts the model property. 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir A WindowStateGuard helps you preventing such inconsistent states. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir The class is not threadsafe. 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir class WindowStateGuard 64*cdf0e10cSrcweir { 65*cdf0e10cSrcweir private: 66*cdf0e10cSrcweir ::rtl::Reference< WindowStateGuard_Impl > m_pImpl; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir public: 69*cdf0e10cSrcweir WindowStateGuard(); 70*cdf0e10cSrcweir ~WindowStateGuard(); 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir void attach( 73*cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow2 >& _rxWindow, 74*cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& _rxModel 75*cdf0e10cSrcweir ); 76*cdf0e10cSrcweir }; 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir //........................................................................ 79*cdf0e10cSrcweir } // namespace frm 80*cdf0e10cSrcweir //........................................................................ 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir #endif // FORMS_WINDOWSTATEGUARD_HXX 83*cdf0e10cSrcweir 84