extensions/source/propctrlr/pcrcommon.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: pcrcommon.hxx,v $
  10  * $Revision: 1.8 $
  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_PCRCOMMON_HXX_
  32 #define _EXTENSIONS_PROPCTRLR_PCRCOMMON_HXX_
  33
  34 #define EDITOR_LIST_APPEND                  (sal_uInt16)-1
  35 #define EDITOR_LIST_REPLACE_EXISTING    (sal_uInt16)-1
  36
  37 /** === begin UNO includes === **/
  38 #include <com/sun/star/uno/Sequence.hxx>
  39 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  40 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  41 /** === end UNO includes === **/
  42
  43 #include <vcl/smartid.hxx>
  44 #include <tools/string.hxx>
  45 #include <toolkit/helper/vclunohelper.hxx>
  46 #include <comphelper/listenernotification.hxx>
  47
  48 //............................................................................
  49 namespace pcr
  50 {
  51 //............................................................................
  52
  53     #define OWN_PROPERTY_ID_INTROSPECTEDOBJECT      0x0010
  54     #define OWN_PROPERTY_ID_CURRENTPAGE             0x0011
  55     #define OWN_PROPERTY_ID_CONTROLCONTEXT          0x0012
  56     #define OWN_PROPERTY_ID_TABBINGMODEL            0x0013
  57
  58     //========================================================================
  59     //= types
  60     //========================================================================
  61     typedef ::comphelper::OSimpleListenerContainer  <   ::com::sun::star::beans::XPropertyChangeListener
  62                                                     ,   ::com::sun::star::beans::PropertyChangeEvent
  63                                                     >   PropertyChangeListeners;
  64
  65     //========================================================================
  66     //= helper
  67     //========================================================================
  68     // small helper to make the "swap" call on an STL container a single-line call, which
  69     // in it's canonic form "aFoo.swap( Container() )" doesn't compile with GCC
  70     template< class CONTAINER >
  71     void clearContainer( CONTAINER& _rContainer )
  72     {
  73         CONTAINER aEmpty;
  74         _rContainer.swap( aEmpty );
  75     }
  76
  77     //========================================================================
  78     //= HelpIdUrl
  79     //========================================================================
  80     /// small helper to translate help ids into help urls
  81     class HelpIdUrl
  82     {
  83     public:
  84         static SmartId getHelpId( const ::rtl::OUString& _rHelpURL );
  85         static ::rtl::OUString getHelpURL( sal_uInt32 _nHelpId );
  86     };
  87
  88     //====================================================================
  89     //= StlSyntaxSequence
  90     //====================================================================
  91     template< class ELEMENT >
  92     class StlSyntaxSequence : public ::com::sun::star::uno::Sequence< ELEMENT >
  93     {
  94     private:
  95         typedef ::com::sun::star::uno::Sequence< ELEMENT >  UnoBase;
  96
  97     public:
  98         inline StlSyntaxSequence() : UnoBase() { }
  99         inline StlSyntaxSequence( const UnoBase& rSeq ) : UnoBase( rSeq ) { }
 100         inline StlSyntaxSequence( const ELEMENT* pElements, sal_Int32 len ) : UnoBase( pElements, len ) { }
 101         inline StlSyntaxSequence( sal_Int32 len ) : UnoBase( len ) { }
 102
 103         operator const UnoBase&() const { return *this; }
 104         operator       UnoBase&()       { return *this; }
 105
 106         typedef const ELEMENT* const_iterator;
 107         typedef       ELEMENT* iterator;
 108
 109         inline const_iterator begin() const { return UnoBase::getConstArray(); }
 110         inline const_iterator end() const { return UnoBase::getConstArray() + UnoBase::getLength(); }
 111
 112         inline iterator begin() { return UnoBase::getArray(); }
 113         inline iterator end() { return UnoBase::getArray() + UnoBase::getLength(); }
 114
 115         inline sal_Int32 size() const { return UnoBase::getLength(); }
 116         inline bool empty() const { return UnoBase::getLength() == 0; }
 117
 118         inline void resize( size_t _newSize ) { UnoBase::realloc( _newSize ); }
 119
 120         inline iterator erase( iterator _pos )
 121         {
 122             iterator loop = end();
 123             while ( --loop != _pos )
 124                 *( loop - 1 ) = *loop;
 125             resize( size() - 1 );
 126         }
 127     };
 128
 129     //========================================================================
 130     //= UNO helpers
 131     //========================================================================
 132 #define DECLARE_XCOMPONENT() \
 133     virtual void SAL_CALL dispose(  ) throw (::com::sun::star::uno::RuntimeException); \
 134     virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException); \
 135     virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
 136
 137 #define IMPLEMENT_FORWARD_XCOMPONENT( classname, baseclass ) \
 138     void SAL_CALL classname::dispose(  ) throw (::com::sun::star::uno::RuntimeException) \
 139     { \
 140     baseclass::WeakComponentImplHelperBase::dispose(); \
 141     } \
 142     void SAL_CALL classname::addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& _Listener ) throw (::com::sun::star::uno::RuntimeException) \
 143     { \
 144         baseclass::WeakComponentImplHelperBase::addEventListener( _Listener ); \
 145     } \
 146     void SAL_CALL classname::removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& _Listener ) throw (::com::sun::star::uno::RuntimeException) \
 147     { \
 148         baseclass::WeakComponentImplHelperBase::removeEventListener( _Listener ); \
 149     } \
 150
 151 //............................................................................
 152 } // namespace pcr
 153 //............................................................................
 154
 155 #endif // _EXTENSIONS_PROPCTRLR_PCRCOMMON_HXX_
 156