forms/source/component/ListBox.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 <FormComponent.hxx>
  23 #include "cachedrowset.hxx"
  24 #include "errorbroadcaster.hxx"
  25 #include "entrylisthelper.hxx"
  26
  27 #include <com/sun/star/form/ListSourceType.hpp>
  28 #include <com/sun/star/awt/XItemListener.hpp>
  29 #include <com/sun/star/awt/XFocusListener.hpp>
  30 #include <com/sun/star/awt/XListBox.hpp>
  31 #include <com/sun/star/form/XChangeBroadcaster.hpp>
  32
  33 #include <comphelper/interfacecontainer3.hxx>
  34 #include <comphelper/asyncnotification.hxx>
  35 #include <connectivity/FValue.hxx>
  36 #include <cppuhelper/implbase4.hxx>
  37 #include <vcl/timer.hxx>
  38 #include <vcl/idle.hxx>
  39
  40 #include <vector>
  41
  42 using namespace comphelper;
  43
  44 /** ListBox is a bit confusing / different from other form components,
  45     so here are a few notes:
  46
  47     The general design philosophy is that a ListBox is a mechanism
  48     to translate back and forth between:
  49      1) *display* values (strings that the user sees and chooses)
  50      2) *binding* values, which is what the program (for a dialog),
  51         the database, ... cares about.
  52
  53     A non-data aware ListBox exposes this mechanism through
  54     com.sun.star.awt.XItemList (get|set)ItemData.
  55
  56     In a data-aware ListBox, this is naturally embodied by the
  57     StringItemList on the one hand, and the ValueList on the other
  58     hand (where, depending on ListSourceType, the ValueList is
  59     possibly automatically filled from the BoundColumn of the
  60     ListSource).
  61
  62     This source file implements data-aware ListBox, and the rest
  63     of this comment applies to data-aware ListBox (only).
  64
  65     In all public APIs of the *model* (OListBoxModel),
  66     the value of the control is the *binding* value.
  67     That is what the bound database field gets,
  68     that is what a validator validates,
  69     that is what an external value binding
  70     (com.sun.star.form.binding.XValueBinding)
  71     exchanges with the control.
  72
  73     As an *implementation* choice, we keep the current value of the
  74     ListBox as a sequence of *indices* in the value list, and do the
  75     lookup on demand:
  76
  77      - ListBox's content property (or value property, sorry the
  78        terminology is not always consistent) is SelectedItems which is
  79        a sequence of *indices* in the value list.
  80
  81      - That is used to synchronise with our peer (UnoControlListBoxModel).
  82
  83     In particular, note that getCurrentValue() is a public API (and
  84     deals with bound values), but getControlValue and
  85     (do)setControlValue are *internal* implementation helpers that
  86     deal with *indices*.
  87
  88     Note that the *view* (OListBoxControl) presents a different story
  89     than the model. E.g. the "SelectedItems" property is *display* *values*.
  90 */
  91
  92
  93 namespace frm
  94 {
  95
  96 typedef ::std::vector< ::connectivity::ORowSetValue >   ValueList;
  97
  98 class OListBoxModel final :public OBoundControlModel
  99                     ,public OEntryListHelper
 100                     ,public OErrorBroadcaster
 101 {
 102
 103     CachedRowSet                                m_aListRowSet;          // the row set to fill the list
 104     ::connectivity::ORowSetValue                m_aSaveValue;
 105
 106     // <properties>
 107     css::form::ListSourceType                   m_eListSourceType;      // type of list source
 108     css::uno::Any                               m_aBoundColumn;
 109     ValueList                                   m_aListSourceValues;
 110     ValueList                                   m_aBoundValues;         // do not write directly; use setBoundValues()
 111     mutable ValueList                           m_aConvertedBoundValues;
 112     mutable sal_Int32                           m_nConvertedBoundValuesType;
 113     css::uno::Sequence<sal_Int16>               m_aDefaultSelectSeq;    // DefaultSelected
 114     // </properties>
 115
 116     mutable sal_Int16                           m_nNULLPos;             // position of the NULL value in our list
 117     sal_Int32                                   m_nBoundColumnType;
 118
 119 private:
 120     ::connectivity::ORowSetValue getFirstSelectedValue() const;
 121
 122     virtual css::uno::Sequence< css::uno::Type>   _getTypes() override;
 123
 124 public:
 125     OListBoxModel(
 126         const css::uno::Reference< css::uno::XComponentContext>& _rxFactory
 127     );
 128     OListBoxModel(
 129         const OListBoxModel* _pOriginal,
 130         const css::uno::Reference< css::uno::XComponentContext>& _rxFactory
 131     );
 132     virtual ~OListBoxModel() override;
 133
 134 // XServiceInfo
 135     OUString SAL_CALL getImplementationName() override
 136     { return "com.sun.star.form.OListBoxModel"; }
 137
 138     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
 139
 140 // UNO binding
 141     DECLARE_UNO3_AGG_DEFAULTS(OListBoxModel, OBoundControlModel)
 142     virtual css::uno::Any SAL_CALL queryAggregation( const css::uno::Type& _rType ) override;
 143
 144 // OComponentHelper
 145     virtual void SAL_CALL disposing() override;
 146
 147 // OPropertySetHelper
 148     virtual void SAL_CALL getFastPropertyValue(css::uno::Any& rValue, sal_Int32 nHandle) const override;
 149     virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
 150     virtual sal_Bool SAL_CALL convertFastPropertyValue(
 151                 css::uno::Any& _rConvertedValue, css::uno::Any& _rOldValue, sal_Int32 _nHandle, const css::uno::Any& _rValue ) override;
 152
 153 private:
 154     static const ::connectivity::ORowSetValue s_aEmptyValue;
 155     static const ::connectivity::ORowSetValue s_aEmptyStringValue;
 156
 157     // XMultiPropertySet
 158     virtual void SAL_CALL   setPropertyValues(const css::uno::Sequence< OUString >& PropertyNames, const css::uno::Sequence< css::uno::Any >& Values) override;
 159
 160     // XPersistObject
 161     virtual OUString SAL_CALL    getServiceName() override;
 162     virtual void SAL_CALL
 163         write(const css::uno::Reference< css::io::XObjectOutputStream>& _rxOutStream) override;
 164     virtual void SAL_CALL
 165         read(const css::uno::Reference< css::io::XObjectInputStream>& _rxInStream) override;
 166
 167     // OControlModel's property handling
 168     virtual void describeFixedProperties(
 169         css::uno::Sequence< css::beans::Property >& /* [out] */ _rProps
 170     ) const override;
 171     virtual void describeAggregateProperties(
 172         css::uno::Sequence< css::beans::Property >& /* [out] */ _rAggregateProps
 173     ) const override;
 174
 175     // XEventListener
 176     virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 177
 178     // OPropertyChangeListener
 179     virtual void    _propertyChanged( const css::beans::PropertyChangeEvent& _rEvt ) override;
 180
 181     // prevent method hiding
 182     using OBoundControlModel::getFastPropertyValue;
 183     using OBoundControlModel::setPropertyValues;
 184
 185     // OBoundControlModel overridables
 186     virtual css::uno::Any   translateDbColumnToControlValue( ) override;
 187     virtual css::uno::Sequence< css::uno::Type >
 188                             getSupportedBindingTypes() override;
 189     virtual css::uno::Any   translateExternalValueToControlValue( const css::uno::Any& _rExternalValue ) const override;
 190     virtual css::uno::Any   translateControlValueToExternalValue( ) const override;
 191     virtual css::uno::Any   translateControlValueToValidatableValue( ) const override;
 192     virtual bool            commitControlValueToDbColumn( bool _bPostReset ) override;
 193
 194     virtual void            onConnectedDbColumn( const css::uno::Reference< css::uno::XInterface >& _rxForm ) override;
 195     virtual void            onDisconnectedDbColumn() override;
 196
 197     virtual css::uno::Any   getDefaultForReset() const override;
 198     virtual void            resetNoBroadcast() override;
 199
 200     virtual css::uno::Any   getCurrentFormComponentValue() const override;
 201
 202     // OEntryListHelper overridables
 203     virtual void    stringItemListChanged( ControlModelLock& _rInstanceLock ) override;
 204     virtual void    refreshInternalEntryList() override;
 205
 206     virtual css::uno::Reference< css::util::XCloneable > SAL_CALL createClone(  ) override;
 207
 208     void init();
 209     css::uno::Any getCurrentSingleValue() const;
 210     css::uno::Sequence<css::uno::Any> getCurrentMultiValue() const;
 211     css::uno::Sequence< sal_Int16 > translateBindingValuesToControlValue(
 212         const css::uno::Sequence< const css::uno::Any > &i_aValues)
 213         const;
 214     css::uno::Sequence< sal_Int16 > translateDbValueToControlValue(
 215         const ::connectivity::ORowSetValue &aValue)
 216         const;
 217
 218     void        loadData( bool _bForce );
 219
 220     /** refreshes the list boxes list data
 221         @precond we don't actually have an external list source
 222     */
 223     void        impl_refreshDbEntryList( bool _bForce );
 224
 225     void        setBoundValues(ValueList &&);
 226     void        clearBoundValues();
 227
 228     ValueList   impl_getValues() const;
 229
 230     sal_Int32   getValueType() const;
 231
 232     void        convertBoundValues(sal_Int32 nType) const;
 233 };
 234
 235
 236 //= OListBoxControl
 237
 238 typedef ::cppu::ImplHelper4 <   css::awt::XFocusListener
 239                             ,   css::awt::XItemListener
 240                             ,   css::awt::XListBox
 241                             ,   css::form::XChangeBroadcaster
 242                             >   OListBoxControl_BASE;
 243
 244 class OListBoxControl   :public OBoundControl
 245                         ,public OListBoxControl_BASE
 246                         ,public IEventProcessor
 247 {
 248 private:
 249     ::comphelper::OInterfaceContainerHelper3<css::form::XChangeListener> m_aChangeListeners;
 250     ::comphelper::OInterfaceContainerHelper3<css::awt::XItemListener> m_aItemListeners;
 251
 252     css::uno::Any                           m_aCurrentSelection;
 253     Idle                                    m_aChangeIdle;
 254
 255     css::uno::Reference< css::awt::XListBox >
 256                                             m_xAggregateListBox;
 257
 258     ::rtl::Reference< ::comphelper::AsyncEventNotifier >
 259                                             m_pItemBroadcaster;
 260
 261 protected:
 262     // UNO binding
 263     virtual css::uno::Sequence< css::uno::Type>   _getTypes() override;
 264
 265 public:
 266     explicit OListBoxControl(const css::uno::Reference< css::uno::XComponentContext>& _rxFactory);
 267     virtual ~OListBoxControl() override;
 268
 269     // UNO binding
 270     DECLARE_UNO3_AGG_DEFAULTS(OListBoxControl, OBoundControl)
 271     virtual css::uno::Any SAL_CALL queryAggregation( const css::uno::Type& _rType ) override;
 272
 273 // XServiceInfo
 274     OUString SAL_CALL getImplementationName() override
 275     { return "com.sun.star.form.OListBoxControl"; }
 276
 277     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
 278
 279 // XChangeBroadcaster
 280         virtual void SAL_CALL addChangeListener(const css::uno::Reference< css::form::XChangeListener>& _rxListener) override;
 281     virtual void SAL_CALL removeChangeListener(const css::uno::Reference< css::form::XChangeListener>& _rxListener) override;
 282
 283 // XFocusListener
 284     virtual void SAL_CALL focusGained(const css::awt::FocusEvent& _rEvent) override;
 285     virtual void SAL_CALL focusLost(const css::awt::FocusEvent& _rEvent) override;
 286
 287 // XItemListener
 288     virtual void SAL_CALL itemStateChanged(const css::awt::ItemEvent& _rEvent) override;
 289
 290 // XEventListener
 291     virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 292
 293 // OComponentHelper
 294     virtual void SAL_CALL disposing() override;
 295
 296 // XListBox
 297     virtual void SAL_CALL addItemListener( const css::uno::Reference< css::awt::XItemListener >& l ) override;
 298     virtual void SAL_CALL removeItemListener( const css::uno::Reference< css::awt::XItemListener >& l ) override;
 299     virtual void SAL_CALL addActionListener( const css::uno::Reference< css::awt::XActionListener >& l ) override;
 300     virtual void SAL_CALL removeActionListener( const css::uno::Reference< css::awt::XActionListener >& l ) override;
 301     virtual void SAL_CALL addItem( const OUString& aItem, ::sal_Int16 nPos ) override;
 302     virtual void SAL_CALL addItems( const css::uno::Sequence< OUString >& aItems, ::sal_Int16 nPos ) override;
 303     virtual void SAL_CALL removeItems( ::sal_Int16 nPos, ::sal_Int16 nCount ) override;
 304     virtual ::sal_Int16 SAL_CALL getItemCount(  ) override;
 305     virtual OUString SAL_CALL getItem( ::sal_Int16 nPos ) override;
 306     virtual css::uno::Sequence< OUString > SAL_CALL getItems(  ) override;
 307     virtual ::sal_Int16 SAL_CALL getSelectedItemPos(  ) override;
 308     virtual css::uno::Sequence< ::sal_Int16 > SAL_CALL getSelectedItemsPos(  ) override;
 309     virtual OUString SAL_CALL getSelectedItem(  ) override;
 310     virtual css::uno::Sequence< OUString > SAL_CALL getSelectedItems(  ) override;
 311     virtual void SAL_CALL selectItemPos( ::sal_Int16 nPos, sal_Bool bSelect ) override;
 312     virtual void SAL_CALL selectItemsPos( const css::uno::Sequence< ::sal_Int16 >& aPositions, sal_Bool bSelect ) override;
 313     virtual void SAL_CALL selectItem( const OUString& aItem, sal_Bool bSelect ) override;
 314     virtual sal_Bool SAL_CALL isMutipleMode(  ) override;
 315     virtual void SAL_CALL setMultipleMode( sal_Bool bMulti ) override;
 316     virtual ::sal_Int16 SAL_CALL getDropDownLineCount(  ) override;
 317     virtual void SAL_CALL setDropDownLineCount( ::sal_Int16 nLines ) override;
 318     virtual void SAL_CALL makeVisible( ::sal_Int16 nEntry ) override;
 319
 320 protected:
 321     // IEventProcessor
 322     virtual void processEvent( const ::comphelper::AnyEvent& _rEvent ) override;
 323
 324 private:
 325     DECL_LINK( OnTimeout, Timer*, void );
 326 };
 327
 328
 329 }
 330
 331
 332 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */