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 #pragma once
  21
  22 #include "commoncontrol.hxx"
  23 #include "pcrcommon.hxx"
  24
  25 #include <com/sun/star/inspection/XNumericControl.hpp>
  26 #include <com/sun/star/inspection/XStringListControl.hpp>
  27 #include <com/sun/star/inspection/XHyperlinkControl.hpp>
  28 #include <com/sun/star/uno/Sequence.hxx>
  29 #include <comphelper/interfacecontainer2.hxx>
  30 #include <svtools/ctrlbox.hxx>
  31 #include <svx/colorbox.hxx>
  32
  33 namespace pcr
  34 {
  35     //= OTimeControl
  36     typedef CommonBehaviourControl<css::inspection::XPropertyControl, weld::FormattedSpinButton> OTimeControl_Base;
  37     class OTimeControl : public OTimeControl_Base
  38     {
  39         std::unique_ptr<weld::TimeFormatter> m_xFormatter;
  40     public:
  41         OTimeControl(std::unique_ptr<weld::FormattedSpinButton> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
  42
  43         virtual void SAL_CALL disposing() override
  44         {
  45             m_xFormatter.reset();
  46             OTimeControl_Base::disposing();
  47         }
  48
  49         // XPropertyControl
  50         virtual css::uno::Any SAL_CALL getValue() override;
  51         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
  52         virtual css::uno::Type SAL_CALL getValueType() override;
  53
  54         virtual void SetModifyHandler() override
  55         {
  56             OTimeControl_Base::SetModifyHandler();
  57             getTypedControlWindow()->connect_value_changed( LINK( this, CommonBehaviourControlHelper, TimeModifiedHdl ) );
  58         }
  59
  60         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
  61     };
  62
  63     //= ODateControl
  64     typedef CommonBehaviourControl<css::inspection::XPropertyControl, weld::Container> ODateControl_Base;
  65     class ODateControl : public ODateControl_Base
  66     {
  67         std::unique_ptr<weld::Entry> m_xEntry;
  68         std::unique_ptr<SvtCalendarBox> m_xCalendarBox;
  69         std::unique_ptr<weld::DateFormatter> m_xEntryFormatter;
  70
  71         DECL_LINK(ActivateHdl, SvtCalendarBox&, void);
  72         DECL_LINK(ToggleHdl, weld::Toggleable&, void);
  73
  74     public:
  75         ODateControl(std::unique_ptr<weld::Container> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
  76
  77         // XPropertyControl
  78         virtual css::uno::Any SAL_CALL getValue() override;
  79         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
  80         virtual css::uno::Type SAL_CALL getValueType() override;
  81
  82         virtual void SetModifyHandler() override
  83         {
  84             ODateControl_Base::SetModifyHandler();
  85
  86             m_xEntry->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
  87             m_xEntryFormatter->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
  88             m_xCalendarBox->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
  89             m_xCalendarBox->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
  90
  91             m_xEntryFormatter->connect_changed(LINK(this, CommonBehaviourControlHelper, EditModifiedHdl));
  92         }
  93
  94         virtual void SAL_CALL disposing() override;
  95
  96         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
  97     };
  98
  99     //= OEditControl
 100     typedef CommonBehaviourControl<css::inspection::XPropertyControl, weld::Entry> OEditControl_Base;
 101     class OEditControl final : public OEditControl_Base
 102     {
 103         bool m_bIsPassword : 1;
 104
 105     public:
 106         OEditControl(std::unique_ptr<weld::Entry> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bPassWord, bool bReadOnly);
 107
 108         // XPropertyControl
 109         virtual css::uno::Any SAL_CALL getValue() override;
 110         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 111         virtual css::uno::Type SAL_CALL getValueType() override;
 112
 113         virtual void SetModifyHandler() override
 114         {
 115             OEditControl_Base::SetModifyHandler();
 116             getTypedControlWindow()->connect_changed( LINK( this, CommonBehaviourControlHelper, EditModifiedHdl ) );
 117         }
 118
 119     private:
 120         // CommonBehaviourControlHelper::modified
 121         virtual void setModified() override;
 122         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 123     };
 124
 125     //= ODateTimeControl
 126     typedef CommonBehaviourControl<css::inspection::XPropertyControl, weld::Container> ODateTimeControl_Base;
 127     class ODateTimeControl : public ODateTimeControl_Base
 128     {
 129     private:
 130         std::unique_ptr<SvtCalendarBox> m_xDate;
 131         std::unique_ptr<weld::FormattedSpinButton> m_xTime;
 132         std::unique_ptr<weld::TimeFormatter> m_xFormatter;
 133
 134     public:
 135         ODateTimeControl(std::unique_ptr<weld::Container> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 136
 137         virtual void SetModifyHandler() override
 138         {
 139             m_xDate->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 140             m_xDate->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 141             m_xTime->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 142             m_xTime->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 143
 144             m_xDate->connect_selected( LINK( this, CommonBehaviourControlHelper, DateModifiedHdl ) );
 145             m_xTime->connect_value_changed( LINK( this, CommonBehaviourControlHelper, TimeModifiedHdl ) );
 146         }
 147
 148         virtual void SAL_CALL disposing() override
 149         {
 150             m_xFormatter.reset();
 151             m_xTime.reset();
 152             m_xDate.reset();
 153             ODateTimeControl_Base::disposing();
 154         }
 155
 156         // XPropertyControl
 157         virtual css::uno::Any SAL_CALL getValue() override;
 158         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 159         virtual css::uno::Type SAL_CALL getValueType() override;
 160
 161         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 162     };
 163
 164     //= OHyperlinkControl
 165     typedef CommonBehaviourControl<css::inspection::XHyperlinkControl, weld::Container> OHyperlinkControl_Base;
 166     class OHyperlinkControl final : public OHyperlinkControl_Base
 167     {
 168     private:
 169         std::unique_ptr<weld::Entry> m_xEntry;
 170         std::unique_ptr<weld::Button> m_xButton;
 171
 172         ::comphelper::OInterfaceContainerHelper2 m_aActionListeners;
 173
 174     public:
 175         OHyperlinkControl(std::unique_ptr<weld::Container> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 176
 177         // XPropertyControl
 178         virtual css::uno::Any SAL_CALL getValue() override;
 179         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 180         virtual css::uno::Type SAL_CALL getValueType() override;
 181
 182         virtual void SetModifyHandler() override
 183         {
 184             m_xEntry->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 185             m_xEntry->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 186             m_xButton->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 187             m_xButton->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 188
 189             m_xEntry->connect_changed( LINK( this, CommonBehaviourControlHelper, EditModifiedHdl ) );
 190         }
 191
 192         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 193
 194         // XHyperlinkControl
 195         virtual void SAL_CALL addActionListener( const css::uno::Reference< css::awt::XActionListener >& listener ) override;
 196         virtual void SAL_CALL removeActionListener( const css::uno::Reference< css::awt::XActionListener >& listener ) override;
 197
 198     private:
 199         // XComponent
 200         virtual void SAL_CALL disposing() override;
 201
 202         DECL_LINK(OnHyperlinkClicked, weld::Button&, void);
 203     };
 204
 205     //= ONumericControl
 206     typedef CommonBehaviourControl<css::inspection::XNumericControl, weld::MetricSpinButton> ONumericControl_Base;
 207     class ONumericControl : public ONumericControl_Base
 208     {
 209     private:
 210         FieldUnit   m_eValueUnit;
 211         sal_Int16   m_nFieldToUNOValueFactor;
 212
 213     public:
 214         ONumericControl(std::unique_ptr<weld::MetricSpinButton> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 215
 216         // XPropertyControl
 217         virtual css::uno::Any SAL_CALL getValue() override;
 218         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 219         virtual css::uno::Type SAL_CALL getValueType() override;
 220
 221         // XNumericControl
 222         virtual ::sal_Int16 SAL_CALL getDecimalDigits() override;
 223         virtual void SAL_CALL setDecimalDigits( ::sal_Int16 _decimaldigits ) override;
 224         virtual css::beans::Optional< double > SAL_CALL getMinValue() override;
 225         virtual void SAL_CALL setMinValue( const css::beans::Optional< double >& _minvalue ) override;
 226         virtual css::beans::Optional< double > SAL_CALL getMaxValue() override;
 227         virtual void SAL_CALL setMaxValue( const css::beans::Optional< double >& _maxvalue ) override;
 228         virtual ::sal_Int16 SAL_CALL getDisplayUnit() override;
 229         virtual void SAL_CALL setDisplayUnit( ::sal_Int16 _displayunit ) override;
 230         virtual ::sal_Int16 SAL_CALL getValueUnit() override;
 231         virtual void SAL_CALL setValueUnit( ::sal_Int16 _valueunit ) override;
 232
 233         virtual void SetModifyHandler() override
 234         {
 235             ONumericControl_Base::SetModifyHandler();
 236             weld::MetricSpinButton* pSpinButton = getTypedControlWindow();
 237             pSpinButton->connect_value_changed( LINK( this, CommonBehaviourControlHelper, MetricModifiedHdl ) );
 238             pSpinButton->get_widget().connect_changed( LINK( this, CommonBehaviourControlHelper, EditModifiedHdl ) );
 239         }
 240
 241     private:
 242         virtual weld::Widget* getWidget() override { return &getTypedControlWindow()->get_widget(); }
 243
 244         /** converts an API value (<code>double</code>, as passed into <code>set[Max|Min|]Value) into
 245             a <code>int</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         sal_Int64 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     //= OColorControl
 258     typedef CommonBehaviourControl<css::inspection::XPropertyControl, ColorListBox> OColorControl_Base;
 259     class OColorControl : public OColorControl_Base
 260     {
 261     public:
 262         OColorControl(std::unique_ptr<ColorListBox> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 263
 264         // XPropertyControl
 265         virtual css::uno::Any SAL_CALL getValue() override;
 266         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 267         virtual css::uno::Type SAL_CALL getValueType() override;
 268
 269         virtual void SetModifyHandler() override
 270         {
 271             OColorControl_Base::SetModifyHandler();
 272             getTypedControlWindow()->SetSelectHdl(LINK(this, CommonBehaviourControlHelper, ColorModifiedHdl));
 273         }
 274
 275     protected:
 276         // CommonBehaviourControlHelper::setModified
 277         virtual void setModified() override;
 278
 279     private:
 280         virtual weld::Widget* getWidget() override { return &getTypedControlWindow()->get_widget(); }
 281     };
 282
 283     //= OListboxControl
 284     typedef CommonBehaviourControl<css::inspection::XStringListControl, weld::ComboBox> OListboxControl_Base;
 285     class OListboxControl : public OListboxControl_Base
 286     {
 287     public:
 288         OListboxControl(std::unique_ptr<weld::ComboBox> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 289
 290         // XPropertyControl
 291         virtual css::uno::Any SAL_CALL getValue() override;
 292         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 293         virtual css::uno::Type SAL_CALL getValueType() override;
 294
 295         // XStringListControl
 296         virtual void SAL_CALL clearList(  ) override;
 297         virtual void SAL_CALL prependListEntry( const OUString& NewEntry ) override;
 298         virtual void SAL_CALL appendListEntry( const OUString& NewEntry ) override;
 299         virtual css::uno::Sequence< OUString > SAL_CALL getListEntries(  ) override;
 300
 301         virtual void SetModifyHandler() override
 302         {
 303             OListboxControl_Base::SetModifyHandler();
 304             getTypedControlWindow()->connect_changed(LINK(this, CommonBehaviourControlHelper, ModifiedHdl));
 305         }
 306
 307     protected:
 308         // CommonBehaviourControlHelper::setModified
 309         virtual void setModified() override;
 310         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 311     };
 312
 313     //= OComboboxControl
 314     typedef CommonBehaviourControl< css::inspection::XStringListControl, weld::ComboBox > OComboboxControl_Base;
 315     class OComboboxControl final : public OComboboxControl_Base
 316     {
 317     public:
 318         OComboboxControl(std::unique_ptr<weld::ComboBox> xWidget, std::unique_ptr<weld::Builder> xBuilder, bool bReadOnly);
 319
 320         // XPropertyControl
 321         virtual css::uno::Any SAL_CALL getValue() override;
 322         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 323         virtual css::uno::Type SAL_CALL getValueType() override;
 324
 325         // XStringListControl
 326         virtual void SAL_CALL clearList(  ) override;
 327         virtual void SAL_CALL prependListEntry( const OUString& NewEntry ) override;
 328         virtual void SAL_CALL appendListEntry( const OUString& NewEntry ) override;
 329         virtual css::uno::Sequence< OUString > SAL_CALL getListEntries(  ) override;
 330
 331         virtual void SetModifyHandler() override
 332         {
 333             OComboboxControl_Base::SetModifyHandler();
 334             getTypedControlWindow()->connect_changed(LINK(this, CommonBehaviourControlHelper, ModifiedHdl));
 335         }
 336
 337         // CommonBehaviourControlHelper::setModified
 338         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 339
 340     private:
 341         DECL_LINK( OnEntrySelected, weld::ComboBox&, void );
 342     };
 343
 344
 345     //= DropDownEditControl
 346
 347     enum MultiLineOperationMode
 348     {
 349         eStringList,
 350         eMultiLineText
 351     };
 352
 353     //= OMultilineEditControl
 354     typedef CommonBehaviourControl<css::inspection::XPropertyControl, weld::Container> OMultilineEditControl_Base;
 355     class OMultilineEditControl : public OMultilineEditControl_Base
 356     {
 357     private:
 358         MultiLineOperationMode m_nOperationMode;
 359         std::unique_ptr<weld::Entry> m_xEntry;
 360         std::unique_ptr<weld::MenuButton> m_xButton;
 361         std::unique_ptr<weld::Widget> m_xPopover;
 362         std::unique_ptr<weld::TextView> m_xTextView;
 363         std::unique_ptr<weld::Button> m_xOk;
 364
 365         void            SetTextValue(const OUString& rText);
 366         OUString        GetTextValue() const;
 367
 368         void            SetStringListValue( const StlSyntaxSequence< OUString >& _rStrings );
 369         StlSyntaxSequence< OUString >
 370                         GetStringListValue() const;
 371
 372         DECL_LINK(ButtonHandler, weld::Button&, void);
 373         DECL_LINK(TextViewModifiedHdl, weld::TextView&, void);
 374
 375         void CheckEntryTextViewMisMatch();
 376
 377     public:
 378         OMultilineEditControl(std::unique_ptr<weld::Container> xWidget, std::unique_ptr<weld::Builder> xBuilder, MultiLineOperationMode eMode, bool bReadOnly);
 379
 380         // XPropertyControl
 381         virtual css::uno::Any SAL_CALL getValue() override;
 382         virtual void SAL_CALL setValue( const css::uno::Any& _value ) override;
 383         virtual css::uno::Type SAL_CALL getValueType() override;
 384         virtual weld::Widget* getWidget() override { return getTypedControlWindow(); }
 385
 386         virtual void editChanged() override;
 387
 388         virtual void SetModifyHandler() override
 389         {
 390             m_xEntry->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 391             m_xEntry->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 392             m_xButton->connect_focus_in( LINK( this, CommonBehaviourControlHelper, GetFocusHdl ) );
 393             m_xButton->connect_focus_out( LINK( this, CommonBehaviourControlHelper, LoseFocusHdl ) );
 394
 395             m_xEntry->connect_changed( LINK( this, CommonBehaviourControlHelper, EditModifiedHdl ) );
 396             m_xTextView->connect_changed( LINK( this, OMultilineEditControl, TextViewModifiedHdl ) );
 397         }
 398
 399         virtual void SAL_CALL disposing() override
 400         {
 401             m_xOk.reset();
 402             m_xTextView.reset();
 403             m_xButton.reset();
 404             m_xEntry.reset();
 405             OMultilineEditControl_Base::disposing();
 406         }
 407
 408     };
 409
 410 } // namespace pcr
 411
 412 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */