extensions/source/propctrlr/pushbuttonnavigation.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: pushbuttonnavigation.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef EXTENSIONS_PROPCTRLR_PUSHBUTTONNAVIGATION_HXX
  32 #define EXTENSIONS_PROPCTRLR_PUSHBUTTONNAVIGATION_HXX
  33
  34 #include <com/sun/star/beans/XPropertySet.hpp>
  35 #include <com/sun/star/beans/PropertyState.hpp>
  36
  37 //............................................................................
  38 namespace pcr
  39 {
  40 //............................................................................
  41
  42     //========================================================================
  43     //= PushButtonNavigation
  44     //========================================================================
  45     class PushButtonNavigation
  46     {
  47     protected:
  48         ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
  49                     m_xControlModel;
  50         sal_Bool    m_bIsPushButton;
  51
  52     public:
  53         /** ctor
  54             @param _rxControlModel
  55                 the control model which is or will be bound
  56         */
  57         PushButtonNavigation(
  58             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel
  59         );
  60
  61         /** returns the current value of the "ButtonType" property, taking into account
  62             the "virtual" button types such as "move-to-next-record button".
  63         */
  64         ::com::sun::star::uno::Any
  65                 getCurrentButtonType() const SAL_THROW(());
  66
  67         /** sets the current value of the "ButtonType" property, taking into account
  68             the "virtual" button types such as "move-to-next-record button".
  69         */
  70         void    setCurrentButtonType( const ::com::sun::star::uno::Any& _rValue ) const SAL_THROW(());
  71
  72         /** retrieves the current state of the "ButtonType" property, taking into account
  73             the "virtual" button types such as "move-to-next-record button".
  74         */
  75         ::com::sun::star::beans::PropertyState
  76                 getCurrentButtonTypeState( ) const SAL_THROW(());
  77
  78         /** returns the current value of the "TargetURL" property, taking into account
  79             that some URLs are special values caused by "virtual" ButtonTypes
  80         */
  81         ::com::sun::star::uno::Any
  82                 getCurrentTargetURL() const SAL_THROW(());
  83
  84         /** sets the current value of the "TargetURL" property, taking into account
  85             that some URLs are special values caused by "virtual" ButtonTypes
  86         */
  87         void    setCurrentTargetURL( const ::com::sun::star::uno::Any& _rValue ) const SAL_THROW(());
  88
  89         /** retrieves the current state of the "TargetURL" property, taking into account
  90             that some URLs are special values caused by "virtual" ButtonTypes
  91         */
  92         ::com::sun::star::beans::PropertyState
  93                 getCurrentTargetURLState( ) const SAL_THROW(());
  94
  95         /** determines whether the current button tpye is FormButtonType_URL
  96         */
  97         bool    currentButtonTypeIsOpenURL() const;
  98
  99         /** determines whether the TargetURL property does currently denote a non-empty string
 100         */
 101         bool    hasNonEmptyCurrentTargetURL() const;
 102
 103     private:
 104         sal_Int32 implGetCurrentButtonType() const SAL_THROW(( ::com::sun::star::uno::Exception ));
 105     };
 106
 107 //............................................................................
 108 }   // namespace pcr
 109 //............................................................................
 110
 111 #endif // EXTENSIONS_PROPCTRLR_PUSHBUTTONNAVIGATION_HXX