extensions/source/propctrlr/standardcontrol.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_STANDARDCONTROL_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_STANDARDCONTROL_HXX
  22
  23 #include "commoncontrol.hxx"
  24 #include "pcrcommon.hxx"
  25
  26 #include <com/sun/star/inspection/XNumericControl.hpp>
  27 #include <com/sun/star/inspection/XStringListControl.hpp>
  28 #include <com/sun/star/inspection/XHyperlinkControl.hpp>
  29 #include <com/sun/star/uno/Sequence.hxx>
  30 #include <vcl/field.hxx>
  31 #include <svtools/ctrlbox.hxx>
  32 #include <vcl/lstbox.hxx>
  33 #include <vcl/combobox.hxx>
  34 #include <svtools/calendar.hxx>
  35 #include <vcl/fmtfield.hxx>
  36 #include <svx/colorbox.hxx>
  37
  38 #include <set>
  39
  40 class PushButton;
  41 class MultiLineEdit;
  42
  43 namespace pcr
  44 {
  45
  46
  47     //= ListLikeControlWithModifyHandler
  48
  49     /** Very small helper class which adds a SetModifyHdl to a ListBox-derived class,
  50         thus giving this class the same API (as far as the CommonBehaviourControl is concerned)
  51         as all other windows.
  52     */
  53     template< class TListboxWindow >
  54     class ListLikeControlWithModifyHandler : public TListboxWindow
  55     {
  56     public:
  57         ListLikeControlWithModifyHandler( vcl::Window* _pParent, WinBits _nStyle )
  58             : TListboxWindow( _pParent, _nStyle )
  59         {
  60             TListboxWindow::SetSelectHdl( LINK(this, ListLikeControlWithModifyHandler, OnSelect) );
  61         }
  62
  63         void SetModifyHdl( const Link<TListboxWindow&,void>& _rLink ) { aModifyHdl = _rLink; }
  64     private:
  65         DECL_LINK(OnSelect, TListboxWindow&, void);
  66         Link<TListboxWindow&,void> aModifyHdl;
  67     };
  68
  69     template< class LISTBOX_WINDOW >
  70     void ListLikeControlWithModifyHandler< LISTBOX_WINDOW >::LinkStubOnSelect(void * instance, LISTBOX_WINDOW& data) {
  71         return static_cast<ListLikeControlWithModifyHandler< LISTBOX_WINDOW > *>(instance)->OnSelect(data);
  72     }
  73     template< class LISTBOX_WINDOW >
  74     void ListLikeControlWithModifyHandler< LISTBOX_WINDOW >::OnSelect(LISTBOX_WINDOW& rListBox)
  75     {
  76         aModifyHdl.Call(rListBox);
  77     }
  78
  79     //= OTimeControl
  80
  81     typedef CommonBehaviourControl< css::inspection::XPropertyControl, TimeField > OTimeControl_Base;
  82     class OTimeControl : public OTimeControl_Base
  83     {
  84     public:
  85         OTimeControl( vcl::Window* pParent, WinBits nWinStyle );
  86
  87         // XPropertyControl
  88         virtual css::uno::Any SAL_CALL getValue() override;
  89         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
  90         virtual css::uno::Type SAL_CALL getValueType() override;
  91     };
  92
  93
  94     //= ODateControl
  95
  96     typedef CommonBehaviourControl< css::inspection::XPropertyControl, CalendarField > ODateControl_Base;
  97     class ODateControl : public ODateControl_Base
  98     {
  99     public:
 100         ODateControl( vcl::Window* pParent, WinBits nWinStyle );
 101
 102         // XPropertyControl
 103         virtual css::uno::Any SAL_CALL getValue() override;
 104         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 105         virtual css::uno::Type SAL_CALL getValueType() override;
 106     };
 107
 108
 109     //= OEditControl
 110
 111     typedef CommonBehaviourControl< css::inspection::XPropertyControl, Edit > OEditControl_Base;
 112     class OEditControl final : public OEditControl_Base
 113     {
 114         bool m_bIsPassword : 1;
 115
 116     public:
 117         OEditControl( vcl::Window* _pParent, bool _bPassWord, WinBits nWinStyle );
 118
 119         // XPropertyControl
 120         virtual css::uno::Any SAL_CALL getValue() override;
 121         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 122         virtual css::uno::Type SAL_CALL getValueType() override;
 123
 124     private:
 125         // CommonBehaviourControlHelper::modified
 126         virtual void setModified() override;
 127     };
 128
 129
 130     //= ODateTimeControl
 131
 132     typedef CommonBehaviourControl< css::inspection::XPropertyControl, FormattedField > ODateTimeControl_Base;
 133     class ODateTimeControl : public ODateTimeControl_Base
 134     {
 135     public:
 136         ODateTimeControl( vcl::Window* pParent,WinBits nWinStyle );
 137
 138         // XPropertyControl
 139         virtual css::uno::Any SAL_CALL getValue() override;
 140         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 141         virtual css::uno::Type SAL_CALL getValueType() override;
 142     };
 143
 144
 145     //= HyperlinkInput
 146
 147     class HyperlinkInput : public Edit
 148     {
 149     private:
 150         Point             m_aMouseButtonDownPos;
 151         Link<void*,void>  m_aClickHandler;
 152
 153     public:
 154         HyperlinkInput( vcl::Window* _pParent, WinBits _nWinStyle );
 155
 156         /** sets the handler which will (asynchronously, with locked SolarMutex) be called
 157             when the hyperlink has been clicked by the user
 158         */
 159         void    SetClickHdl( const Link<void*,void>& _rHdl ) { m_aClickHandler = _rHdl; }
 160
 161     protected:
 162         virtual void        MouseMove( const MouseEvent& rMEvt ) override;
 163         virtual void        MouseButtonDown( const MouseEvent& rMEvt ) override;
 164         virtual void        MouseButtonUp( const MouseEvent& rMEvt ) override;
 165         virtual void        Tracking( const TrackingEvent& rTEvt ) override;
 166
 167     private:
 168         void    impl_checkEndClick( const MouseEvent& rMEvt );
 169         bool    impl_textHitTest( const Point& rWindowPos );
 170     };
 171
 172
 173     //= OHyperlinkControl
 174
 175     typedef CommonBehaviourControl< css::inspection::XHyperlinkControl, HyperlinkInput > OHyperlinkControl_Base;
 176     class OHyperlinkControl final : public OHyperlinkControl_Base
 177     {
 178         ::comphelper::OInterfaceContainerHelper2   m_aActionListeners;
 179
 180     public:
 181         OHyperlinkControl( vcl::Window* _pParent, WinBits _nWinStyle );
 182
 183         // XPropertyControl
 184         virtual css::uno::Any SAL_CALL getValue() override;
 185         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 186         virtual css::uno::Type SAL_CALL getValueType() override;
 187
 188         // XHyperlinkControl
 189         virtual void SAL_CALL addActionListener( const css::uno::Reference< css::awt::XActionListener >& listener ) override;
 190         virtual void SAL_CALL removeActionListener( const css::uno::Reference< css::awt::XActionListener >& listener ) override;
 191
 192     private:
 193         // XComponent
 194         virtual void SAL_CALL disposing() override;
 195
 196         DECL_LINK( OnHyperlinkClicked, void*, void );
 197     };
 198
 199
 200     //= CustomConvertibleNumericField
 201
 202     class CustomConvertibleNumericField : public MetricField
 203     {
 204     public:
 205         CustomConvertibleNumericField( vcl::Window* _pParent, WinBits _nStyle )
 206             :MetricField( _pParent, _nStyle )
 207         {
 208         }
 209
 210         sal_Int64 GetLastValue() const { return mnLastValue; }
 211     };
 212
 213
 214     //= ONumericControl
 215
 216     typedef CommonBehaviourControl< css::inspection::XNumericControl, CustomConvertibleNumericField > ONumericControl_Base;
 217     class ONumericControl : public ONumericControl_Base
 218     {
 219     private:
 220         FieldUnit   m_eValueUnit;
 221         sal_Int16   m_nFieldToUNOValueFactor;
 222
 223     public:
 224         ONumericControl( vcl::Window* pParent, WinBits nWinStyle );
 225
 226         // XPropertyControl
 227         virtual css::uno::Any SAL_CALL getValue() override;
 228         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 229         virtual css::uno::Type SAL_CALL getValueType() override;
 230
 231         // XNumericControl
 232         virtual ::sal_Int16 SAL_CALL getDecimalDigits() override;
 233         virtual void SAL_CALL setDecimalDigits( ::sal_Int16 _decimaldigits ) override;
 234         virtual css::beans::Optional< double > SAL_CALL getMinValue() override;
 235         virtual void SAL_CALL setMinValue( const css::beans::Optional< double >& _minvalue ) override;
 236         virtual css::beans::Optional< double > SAL_CALL getMaxValue() override;
 237         virtual void SAL_CALL setMaxValue( const css::beans::Optional< double >& _maxvalue ) override;
 238         virtual ::sal_Int16 SAL_CALL getDisplayUnit() override;
 239         virtual void SAL_CALL setDisplayUnit( ::sal_Int16 _displayunit ) override;
 240         virtual ::sal_Int16 SAL_CALL getValueUnit() override;
 241         virtual void SAL_CALL setValueUnit( ::sal_Int16 _valueunit ) override;
 242
 243     private:
 244         /** converts an API value (<code>double</code>, as passed into <code>set[Max|Min|]Value) into
 245             a <code>long</code> value which can be passed to our NumericField.
 246
 247             The conversion respects our decimal digits as well as our value factor (<member>m_nFieldToUNOValueFactor</member>).
 248         */
 249         long    impl_apiValueToFieldValue_nothrow( double _nApiValue ) const;
 250
 251         /** converts a control value, as obtained from our Numeric field, into a value which can passed
 252             to outer callers via our UNO API.
 253         */
 254         double  impl_fieldValueToApiValue_nothrow( sal_Int64 _nFieldValue ) const;
 255     };
 256
 257
 258     //= OColorControl
 259
 260     typedef CommonBehaviourControl  <   css::inspection::XPropertyControl
 261                                     ,   ListLikeControlWithModifyHandler<SvxColorListBox>
 262                                     >   OColorControl_Base;
 263     class OColorControl : public OColorControl_Base
 264     {
 265     public:
 266         OColorControl( vcl::Window* pParent, WinBits nWinStyle );
 267
 268         // XPropertyControl
 269         virtual css::uno::Any SAL_CALL getValue() override;
 270         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 271         virtual css::uno::Type SAL_CALL getValueType() override;
 272
 273     protected:
 274         // CommonBehaviourControlHelper::setModified
 275         virtual void setModified() override;
 276     };
 277
 278
 279     //= OListboxControl
 280
 281     typedef CommonBehaviourControl  <   css::inspection::XStringListControl
 282                                     ,   ListLikeControlWithModifyHandler< ListBox >
 283                                     >   OListboxControl_Base;
 284     class OListboxControl : public OListboxControl_Base
 285     {
 286     public:
 287         OListboxControl( vcl::Window* pParent, WinBits nWinStyle );
 288
 289         // XPropertyControl
 290         virtual css::uno::Any SAL_CALL getValue() override;
 291         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 292         virtual css::uno::Type SAL_CALL getValueType() override;
 293
 294         // XStringListControl
 295         virtual void SAL_CALL clearList(  ) override;
 296         virtual void SAL_CALL prependListEntry( const OUString& NewEntry ) override;
 297         virtual void SAL_CALL appendListEntry( const OUString& NewEntry ) override;
 298         virtual css::uno::Sequence< OUString > SAL_CALL getListEntries(  ) override;
 299
 300     protected:
 301         // CommonBehaviourControlHelper::setModified
 302         virtual void setModified() override;
 303     };
 304
 305
 306     //= OComboboxControl
 307
 308     typedef CommonBehaviourControl< css::inspection::XStringListControl, ComboBox > OComboboxControl_Base;
 309     class OComboboxControl final : public OComboboxControl_Base
 310     {
 311     public:
 312         OComboboxControl( vcl::Window* pParent, WinBits nWinStyle );
 313
 314         // XPropertyControl
 315         virtual css::uno::Any SAL_CALL getValue() override;
 316         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 317         virtual css::uno::Type SAL_CALL getValueType() override;
 318
 319         // XStringListControl
 320         virtual void SAL_CALL clearList(  ) override;
 321         virtual void SAL_CALL prependListEntry( const OUString& NewEntry ) override;
 322         virtual void SAL_CALL appendListEntry( const OUString& NewEntry ) override;
 323         virtual css::uno::Sequence< OUString > SAL_CALL getListEntries(  ) override;
 324
 325     private:
 326         DECL_LINK( OnEntrySelected, ComboBox&, void );
 327     };
 328
 329
 330     //= DropDownEditControl
 331
 332     enum MultiLineOperationMode
 333     {
 334         eStringList,
 335         eMultiLineText
 336     };
 337
 338     //= DropDownEditControl
 339
 340     class OMultilineFloatingEdit;
 341     /** an Edit field which can be used as ControlWindow, and has a drop-down button
 342     */
 343     class DropDownEditControl final : public Edit
 344     {
 345         VclPtr<OMultilineFloatingEdit>      m_pFloatingEdit;
 346         VclPtr<MultiLineEdit>               m_pImplEdit;
 347         VclPtr<PushButton>                  m_pDropdownButton;
 348         MultiLineOperationMode              m_nOperationMode;
 349         bool                                m_bDropdown : 1;
 350         CommonBehaviourControlHelper*       m_pHelper;
 351
 352     public:
 353         DropDownEditControl( vcl::Window* _pParent, WinBits _nStyle );
 354         virtual ~DropDownEditControl() override;
 355         virtual void dispose() override;
 356
 357         void           setControlHelper( CommonBehaviourControlHelper& _rControlHelper );
 358         void setOperationMode( MultiLineOperationMode _eMode ) { m_nOperationMode = _eMode; }
 359         MultiLineOperationMode getOperationMode() const { return m_nOperationMode; }
 360
 361         void            SetTextValue( const OUString& _rText );
 362         OUString        GetTextValue() const;
 363
 364         void            SetStringListValue( const StlSyntaxSequence< OUString >& _rStrings );
 365         StlSyntaxSequence< OUString >
 366                         GetStringListValue() const;
 367
 368     private:
 369         // Window overridables
 370         virtual bool    PreNotify( NotifyEvent& rNEvt ) override;
 371         virtual void    Resize() override;
 372
 373         long            FindPos(long nSinglePos);
 374
 375         DECL_LINK( ReturnHdl, FloatingWindow*, void );
 376         DECL_LINK( DropDownHdl, Button*, void );
 377
 378         void ShowDropDown( bool bShow );
 379     };
 380
 381
 382     //= OMultilineEditControl
 383
 384     typedef CommonBehaviourControl< css::inspection::XPropertyControl, DropDownEditControl > OMultilineEditControl_Base;
 385     class OMultilineEditControl : public OMultilineEditControl_Base
 386     {
 387     public:
 388         OMultilineEditControl( vcl::Window* pParent, MultiLineOperationMode _eMode, WinBits nWinStyle  );
 389
 390         // XPropertyControl
 391         virtual css::uno::Any SAL_CALL getValue() override;
 392         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 393         virtual css::uno::Type SAL_CALL getValueType() override;
 394     };
 395
 396
 397 } // namespace pcr
 398
 399
 400 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_STANDARDCONTROL_HXX
 401
 402 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */