extensions/source/propctrlr/standardcontrol.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: standardcontrol.hxx,v $
  10  * $Revision: 1.10 $
  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_STANDARDCONTROL_HXX_
  32 #define _EXTENSIONS_PROPCTRLR_STANDARDCONTROL_HXX_
  33
  34 #include "commoncontrol.hxx"
  35 #include "pcrcommon.hxx"
  36
  37 /** === begin UNO includes === **/
  38 #include <com/sun/star/inspection/XNumericControl.hpp>
  39 #include <com/sun/star/inspection/XStringListControl.hpp>
  40 #include <com/sun/star/inspection/XHyperlinkControl.hpp>
  41 #include <com/sun/star/uno/Sequence.hxx>
  42 /** === end UNO includes === **/
  43 #include <vcl/field.hxx>
  44 #include <vcl/longcurr.hxx>
  45 #include <svtools/ctrlbox.hxx>
  46 #include <vcl/lstbox.hxx>
  47 #include <vcl/combobox.hxx>
  48 #include <svtools/calendar.hxx>
  49 #include <svtools/fmtfield.hxx>
  50
  51 #include <set>
  52
  53 class PushButton;
  54 class MultiLineEdit;
  55 //............................................................................
  56 namespace pcr
  57 {
  58 //............................................................................
  59
  60     //========================================================================
  61     //= ListLikeControlWithModifyHandler
  62     //========================================================================
  63     /** Very small helper class which adds a SetModifyHdl to a ListBox-derived class,
  64         thus giving this class the same API (as far as the CommonBehaviourControl is concerned)
  65         as all other windows.
  66     */
  67     template< class LISTBOX_WINDOW >
  68     class ListLikeControlWithModifyHandler : public ControlWindow< LISTBOX_WINDOW >
  69     {
  70     protected:
  71         typedef ControlWindow< LISTBOX_WINDOW >  ListBoxType;
  72     public:
  73         ListLikeControlWithModifyHandler( Window* _pParent, WinBits _nStyle )
  74             :ListBoxType( _pParent, _nStyle )
  75         {
  76         }
  77
  78         void SetModifyHdl( const Link& _rLink ) { ListBoxType::SetSelectHdl( _rLink ); }
  79     };
  80
  81     //========================================================================
  82     //= OTimeControl
  83     //========================================================================
  84     typedef CommonBehaviourControl< ::com::sun::star::inspection::XPropertyControl, ControlWindow< TimeField > > OTimeControl_Base;
  85     class OTimeControl : public OTimeControl_Base
  86     {
  87     public:
  88         OTimeControl( Window* pParent, WinBits nWinStyle );
  89
  90         // XPropertyControl
  91         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
  92         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
  93         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
  94     };
  95
  96     //========================================================================
  97     //= ODateControl
  98     //========================================================================
  99     typedef CommonBehaviourControl< ::com::sun::star::inspection::XPropertyControl, ControlWindow< CalendarField > > ODateControl_Base;
 100     class ODateControl : public ODateControl_Base
 101     {
 102     public:
 103         ODateControl( Window* pParent, WinBits nWinStyle );
 104
 105         // XPropertyControl
 106         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 107         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 108         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 109     };
 110
 111     //========================================================================
 112     //= OEditControl
 113     //========================================================================
 114     typedef CommonBehaviourControl< ::com::sun::star::inspection::XPropertyControl, ControlWindow< Edit > > OEditControl_Base;
 115     class OEditControl : public OEditControl_Base
 116     {
 117     protected:
 118         sal_Bool m_bIsPassword : 1;
 119
 120     public:
 121         OEditControl( Window* _pParent, sal_Bool _bPassWord, WinBits nWinStyle );
 122
 123         // XPropertyControl
 124         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 125         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 126         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 127
 128     protected:
 129         virtual void modified();
 130     };
 131
 132     //========================================================================
 133     //= ODateTimeControl
 134     //========================================================================
 135     typedef CommonBehaviourControl< ::com::sun::star::inspection::XPropertyControl, ControlWindow< FormattedField > > ODateTimeControl_Base;
 136     class ODateTimeControl : public ODateTimeControl_Base
 137     {
 138     public:
 139         ODateTimeControl( Window* pParent,WinBits nWinStyle );
 140
 141         // XPropertyControl
 142         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 143         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 144         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 145     };
 146
 147     //========================================================================
 148     //= HyperlinkInput
 149     //========================================================================
 150     class HyperlinkInput : public Edit
 151     {
 152     private:
 153         Point   m_aMouseButtonDownPos;
 154         Link    m_aClickHandler;
 155
 156     public:
 157         HyperlinkInput( Window* _pParent, WinBits _nWinStyle );
 158
 159         /** sets the handler which will (asynchronously, with locked SolarMutex) be called
 160             when the hyperlink has been clicked by the user
 161         */
 162         void        SetClickHdl( const Link& _rHdl ) { m_aClickHandler = _rHdl; }
 163         const Link& GetClickHdl( ) const { return m_aClickHandler; }
 164
 165     protected:
 166         virtual void        MouseMove( const MouseEvent& rMEvt );
 167         virtual void        MouseButtonDown( const MouseEvent& rMEvt );
 168         virtual void        MouseButtonUp( const MouseEvent& rMEvt );
 169         virtual void        Tracking( const TrackingEvent& rTEvt );
 170
 171     private:
 172         void    impl_checkEndClick( const MouseEvent rMEvt );
 173         bool    impl_textHitTest( const Point& _rWindowPos );
 174     };
 175
 176     //========================================================================
 177     //= OHyperlinkControl
 178     //========================================================================
 179     typedef CommonBehaviourControl< ::com::sun::star::inspection::XHyperlinkControl, ControlWindow< HyperlinkInput > > OHyperlinkControl_Base;
 180     class OHyperlinkControl : public OHyperlinkControl_Base
 181     {
 182     private:
 183         ::cppu::OInterfaceContainerHelper   m_aActionListeners;
 184
 185     public:
 186         OHyperlinkControl( Window* _pParent, WinBits _nWinStyle );
 187
 188         // XPropertyControl
 189         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 190         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 191         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 192
 193         // XHyperlinkControl
 194         virtual void SAL_CALL addActionListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XActionListener >& listener ) throw (::com::sun::star::uno::RuntimeException);
 195         virtual void SAL_CALL removeActionListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XActionListener >& listener ) throw (::com::sun::star::uno::RuntimeException);
 196
 197     protected:
 198         // XComponent
 199         virtual void SAL_CALL disposing();
 200
 201     protected:
 202         DECL_LINK( OnHyperlinkClicked, void* );
 203     };
 204
 205     //========================================================================
 206     //= CustomConvertibleNumericField
 207     //========================================================================
 208     class CustomConvertibleNumericField : public ControlWindow< MetricField >
 209     {
 210         typedef ControlWindow< MetricField > BaseClass;
 211
 212     public:
 213         CustomConvertibleNumericField( Window* _pParent, WinBits _nStyle )
 214             :BaseClass( _pParent, _nStyle )
 215         {
 216         }
 217
 218         sal_Int64 GetLastValue() const { return mnLastValue; }
 219     };
 220
 221     //========================================================================
 222     //= ONumericControl
 223     //========================================================================
 224     typedef CommonBehaviourControl< ::com::sun::star::inspection::XNumericControl, CustomConvertibleNumericField > ONumericControl_Base;
 225     class ONumericControl : public ONumericControl_Base
 226     {
 227     private:
 228         FieldUnit   m_eValueUnit;
 229         sal_Int16   m_nFieldToUNOValueFactor;
 230
 231     public:
 232         ONumericControl( Window* pParent, WinBits nWinStyle );
 233
 234         // XPropertyControl
 235         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 236         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 237         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 238
 239         // XNumericControl
 240         virtual ::sal_Int16 SAL_CALL getDecimalDigits() throw (::com::sun::star::uno::RuntimeException);
 241         virtual void SAL_CALL setDecimalDigits( ::sal_Int16 _decimaldigits ) throw (::com::sun::star::uno::RuntimeException);
 242         virtual ::com::sun::star::beans::Optional< double > SAL_CALL getMinValue() throw (::com::sun::star::uno::RuntimeException);
 243         virtual void SAL_CALL setMinValue( const ::com::sun::star::beans::Optional< double >& _minvalue ) throw (::com::sun::star::uno::RuntimeException);
 244         virtual ::com::sun::star::beans::Optional< double > SAL_CALL getMaxValue() throw (::com::sun::star::uno::RuntimeException);
 245         virtual void SAL_CALL setMaxValue( const ::com::sun::star::beans::Optional< double >& _maxvalue ) throw (::com::sun::star::uno::RuntimeException);
 246         virtual ::sal_Int16 SAL_CALL getDisplayUnit() throw (::com::sun::star::uno::RuntimeException);
 247         virtual void SAL_CALL setDisplayUnit( ::sal_Int16 _displayunit ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 248         virtual ::sal_Int16 SAL_CALL getValueUnit() throw (::com::sun::star::uno::RuntimeException);
 249         virtual void SAL_CALL setValueUnit( ::sal_Int16 _valueunit ) throw (::com::sun::star::uno::RuntimeException);
 250
 251     private:
 252         /** converts an API value (<code>double</code>, as passed into <code>set[Max|Min|]Value) into
 253             a <code>long</code> value which can be passed to our NumericField.
 254
 255             The conversion respects our decimal digits as well as our value factor (<member>m_nFieldToUNOValueFactor</member>).
 256         */
 257         long    impl_apiValueToFieldValue_nothrow( double _nApiValue ) const;
 258
 259         /** converts a control value, as obtained from our Numeric field, into a value which can passed
 260             to outer callers via our UNO API.
 261         */
 262         double  impl_fieldValueToApiValue_nothrow( sal_Int64 _nFieldValue ) const;
 263     };
 264
 265     //========================================================================
 266     //= OColorControl
 267     //========================================================================
 268     typedef CommonBehaviourControl  <   ::com::sun::star::inspection::XStringListControl
 269                                     ,   ListLikeControlWithModifyHandler< ColorListBox >
 270                                     >   OColorControl_Base;
 271     class OColorControl : public OColorControl_Base
 272     {
 273     private:
 274         ::std::set< ::rtl::OUString >   m_aNonColorEntries;
 275
 276     public:
 277         OColorControl( Window* pParent, WinBits nWinStyle );
 278
 279         // XPropertyControl
 280         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 281         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 282         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 283
 284         // XStringListControl
 285         virtual void SAL_CALL clearList(  ) throw (::com::sun::star::uno::RuntimeException);
 286         virtual void SAL_CALL prependListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 287         virtual void SAL_CALL appendListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 288         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getListEntries(  ) throw (::com::sun::star::uno::RuntimeException);
 289
 290     protected:
 291         virtual void modified();
 292     };
 293
 294     //========================================================================
 295     //= OListboxControl
 296     //========================================================================
 297     typedef CommonBehaviourControl  <   ::com::sun::star::inspection::XStringListControl
 298                                     ,   ListLikeControlWithModifyHandler< ListBox >
 299                                     >   OListboxControl_Base;
 300     class OListboxControl : public OListboxControl_Base
 301     {
 302     public:
 303         OListboxControl( Window* pParent, WinBits nWinStyle );
 304
 305         // XPropertyControl
 306         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 307         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 308         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 309
 310         // XStringListControl
 311         virtual void SAL_CALL clearList(  ) throw (::com::sun::star::uno::RuntimeException);
 312         virtual void SAL_CALL prependListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 313         virtual void SAL_CALL appendListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 314         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getListEntries(  ) throw (::com::sun::star::uno::RuntimeException);
 315
 316     protected:
 317         virtual void modified();
 318     };
 319
 320     //========================================================================
 321     //= OComboboxControl
 322     //========================================================================
 323     typedef CommonBehaviourControl< ::com::sun::star::inspection::XStringListControl, ControlWindow< ComboBox > > OComboboxControl_Base;
 324     class OComboboxControl : public OComboboxControl_Base
 325     {
 326     public:
 327         OComboboxControl( Window* pParent, WinBits nWinStyle );
 328
 329         // XPropertyControl
 330         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 331         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 332         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 333
 334         // XStringListControl
 335         virtual void SAL_CALL clearList(  ) throw (::com::sun::star::uno::RuntimeException);
 336         virtual void SAL_CALL prependListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 337         virtual void SAL_CALL appendListEntry( const ::rtl::OUString& NewEntry ) throw (::com::sun::star::uno::RuntimeException);
 338         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getListEntries(  ) throw (::com::sun::star::uno::RuntimeException);
 339
 340     protected:
 341         DECL_LINK( OnEntrySelected, void* );
 342     };
 343
 344     //========================================================================
 345     //= DropDownEditControl
 346     //========================================================================
 347     enum MultiLineOperationMode
 348     {
 349         eStringList,
 350         eMultiLineText
 351     };
 352     //========================================================================
 353     //= DropDownEditControl
 354     //========================================================================
 355     class OMultilineFloatingEdit;
 356     typedef ControlWindow< Edit > DropDownEditControl_Base;
 357     /** an Edit field which can be used as ControlWindow, and has a drop-down button
 358     */
 359     class DropDownEditControl : public DropDownEditControl_Base
 360     {
 361     private:
 362         OMultilineFloatingEdit*             m_pFloatingEdit;
 363         MultiLineEdit*                      m_pImplEdit;
 364         PushButton*                         m_pDropdownButton;
 365         MultiLineOperationMode              m_nOperationMode;
 366         sal_Bool                            m_bDropdown : 1;
 367
 368     public:
 369         DropDownEditControl( Window* _pParent, WinBits _nStyle );
 370         ~DropDownEditControl();
 371
 372         void setOperationMode( MultiLineOperationMode _eMode ) { m_nOperationMode = _eMode; }
 373         MultiLineOperationMode getOperationMode() const { return m_nOperationMode; }
 374
 375         void            SetTextValue( const ::rtl::OUString& _rText );
 376         ::rtl::OUString GetTextValue() const;
 377
 378         void            SetStringListValue( const StlSyntaxSequence< ::rtl::OUString >& _rStrings );
 379         StlSyntaxSequence< ::rtl::OUString >
 380                         GetStringListValue() const;
 381
 382         // ControlWindow overridables
 383         virtual void setControlHelper( ControlHelper& _rControlHelper );
 384
 385     protected:
 386         // Window overridables
 387         virtual long    PreNotify( NotifyEvent& rNEvt );
 388         virtual void    Resize();
 389
 390     protected:
 391         long            FindPos(long nSinglePos);
 392
 393     private:
 394         DECL_LINK( ReturnHdl, OMultilineFloatingEdit* );
 395         DECL_LINK( DropDownHdl, PushButton* );
 396
 397         sal_Bool ShowDropDown( sal_Bool bShow );
 398     };
 399
 400     //========================================================================
 401     //= OMultilineEditControl
 402     //========================================================================
 403     typedef CommonBehaviourControl< ::com::sun::star::inspection::XPropertyControl, DropDownEditControl > OMultilineEditControl_Base;
 404     class OMultilineEditControl : public OMultilineEditControl_Base
 405     {
 406     public:
 407         OMultilineEditControl( Window* pParent, MultiLineOperationMode _eMode, WinBits nWinStyle  );
 408
 409         // XPropertyControl
 410         virtual ::com::sun::star::uno::Any SAL_CALL getValue() throw (::com::sun::star::uno::RuntimeException);
 411         virtual void SAL_CALL setValue( const ::com::sun::star::uno::Any& _value ) throw (::com::sun::star::beans::IllegalTypeException, ::com::sun::star::uno::RuntimeException);
 412         virtual ::com::sun::star::uno::Type SAL_CALL getValueType() throw (::com::sun::star::uno::RuntimeException);
 413     };
 414
 415 //............................................................................
 416 } // namespace pcr
 417 //............................................................................
 418
 419 #endif // _EXTENSIONS_PROPCTRLR_STANDARDCONTROL_HXX_
 420