framework/source/uielement/comboboxtoolbarcontroller.cxx

   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 #include <uielement/comboboxtoolbarcontroller.hxx>
  21
  22 #include <com/sun/star/beans/PropertyValue.hpp>
  23
  24 #include <comphelper/propertyvalue.hxx>
  25 #include <vcl/InterimItemWindow.hxx>
  26 #include <svtools/toolboxcontroller.hxx>
  27 #include <vcl/svapp.hxx>
  28 #include <vcl/toolbox.hxx>
  29
  30 using namespace ::com::sun::star;
  31 using namespace css::uno;
  32 using namespace css::beans;
  33 using namespace css::frame;
  34
  35 namespace framework
  36 {
  37
  38 // Wrapper class to notify controller about events from combobox.
  39 // Unfortunately the events are notified through virtual methods instead
  40 // of Listeners.
  41
  42 class ComboBoxControl final : public InterimItemWindow
  43 {
  44 public:
  45     ComboBoxControl(vcl::Window* pParent, ComboboxToolbarController* pComboboxToolbarController);
  46     virtual ~ComboBoxControl() override;
  47     virtual void dispose() override;
  48
  49     void set_active_or_entry_text(const OUString& rText);
  50     OUString get_active_text() const { return m_xWidget->get_active_text(); }
  51
  52     void clear() { m_xWidget->clear(); }
  53     void remove(int nIndex) { m_xWidget->remove(nIndex); }
  54     void append_text(const OUString& rStr) { m_xWidget->append_text(rStr); }
  55     void insert_text(int pos, const OUString& rStr) { m_xWidget->insert_text(pos, rStr); }
  56     int get_count() const { return m_xWidget->get_count(); }
  57     int find_text(const OUString& rStr) const { return m_xWidget->find_text(rStr); }
  58
  59     DECL_LINK(FocusInHdl, weld::Widget&, void);
  60     DECL_LINK(FocusOutHdl, weld::Widget&, void);
  61     DECL_LINK(ModifyHdl, weld::ComboBox&, void);
  62     DECL_LINK(ActivateHdl, weld::ComboBox&, bool);
  63     DECL_LINK(KeyInputHdl, const ::KeyEvent&, bool);
  64
  65 private:
  66     std::unique_ptr<weld::ComboBox> m_xWidget;
  67     ComboboxToolbarController* m_pComboboxToolbarController;
  68 };
  69
  70 ComboBoxControl::ComboBoxControl(vcl::Window* pParent, ComboboxToolbarController* pComboboxToolbarController)
  71     : InterimItemWindow(pParent, u"svt/ui/combocontrol.ui"_ustr, u"ComboControl"_ustr)
  72     , m_xWidget(m_xBuilder->weld_combo_box(u"combobox"_ustr))
  73     , m_pComboboxToolbarController(pComboboxToolbarController)
  74 {
  75     InitControlBase(m_xWidget.get());
  76
  77     m_xWidget->connect_focus_in(LINK(this, ComboBoxControl, FocusInHdl));
  78     m_xWidget->connect_focus_out(LINK(this, ComboBoxControl, FocusOutHdl));
  79     m_xWidget->connect_changed(LINK(this, ComboBoxControl, ModifyHdl));
  80     m_xWidget->connect_entry_activate(LINK(this, ComboBoxControl, ActivateHdl));
  81     m_xWidget->connect_key_press(LINK(this, ComboBoxControl, KeyInputHdl));
  82
  83     m_xWidget->set_entry_width_chars(1); // so a smaller than default width can be used by ComboboxToolbarController
  84     SetSizePixel(get_preferred_size());
  85 }
  86
  87 IMPL_LINK(ComboBoxControl, KeyInputHdl, const ::KeyEvent&, rKEvt, bool)
  88 {
  89     return ChildKeyInput(rKEvt);
  90 }
  91
  92 void ComboBoxControl::set_active_or_entry_text(const OUString& rText)
  93 {
  94     const int nFound = m_xWidget->find_text(rText);
  95     if (nFound != -1)
  96         m_xWidget->set_active(nFound);
  97     else
  98         m_xWidget->set_entry_text(rText);
  99 }
 100
 101 ComboBoxControl::~ComboBoxControl()
 102 {
 103     disposeOnce();
 104 }
 105
 106 void ComboBoxControl::dispose()
 107 {
 108     m_pComboboxToolbarController = nullptr;
 109     m_xWidget.reset();
 110     InterimItemWindow::dispose();
 111 }
 112
 113 IMPL_LINK_NOARG(ComboBoxControl, ModifyHdl, weld::ComboBox&, void)
 114 {
 115     if (m_pComboboxToolbarController)
 116     {
 117         if (m_xWidget->get_count() && m_xWidget->changed_by_direct_pick())
 118             m_pComboboxToolbarController->Select();
 119         else
 120             m_pComboboxToolbarController->Modify();
 121     }
 122 }
 123
 124 IMPL_LINK_NOARG(ComboBoxControl, FocusInHdl, weld::Widget&, void)
 125 {
 126     if (m_pComboboxToolbarController)
 127         m_pComboboxToolbarController->GetFocus();
 128 }
 129
 130 IMPL_LINK_NOARG(ComboBoxControl, FocusOutHdl, weld::Widget&, void)
 131 {
 132     if (m_pComboboxToolbarController)
 133         m_pComboboxToolbarController->LoseFocus();
 134 }
 135
 136 IMPL_LINK_NOARG(ComboBoxControl, ActivateHdl, weld::ComboBox&, bool)
 137 {
 138     if (m_pComboboxToolbarController)
 139         m_pComboboxToolbarController->Activate();
 140     return true;
 141 }
 142
 143 ComboboxToolbarController::ComboboxToolbarController(
 144     const Reference< XComponentContext >& rxContext,
 145     const Reference< XFrame >&            rFrame,
 146     ToolBox*                              pToolbar,
 147     ToolBoxItemId                         nID,
 148     sal_Int32                             nWidth,
 149     const OUString&                       aCommand ) :
 150     ComplexToolbarController( rxContext, rFrame, pToolbar, nID, aCommand )
 151     ,   m_pComboBox( nullptr )
 152 {
 153     m_pComboBox = VclPtr<ComboBoxControl>::Create(m_xToolbar, this);
 154     if ( nWidth == 0 )
 155         nWidth = 100;
 156
 157     // ComboBoxControl ctor has set a suitable height already
 158     auto nHeight = m_pComboBox->GetSizePixel().Height();
 159
 160     m_pComboBox->SetSizePixel( ::Size( nWidth, nHeight ));
 161     m_xToolbar->SetItemWindow( m_nID, m_pComboBox );
 162 }
 163
 164 ComboboxToolbarController::~ComboboxToolbarController()
 165 {
 166 }
 167
 168 void SAL_CALL ComboboxToolbarController::dispose()
 169 {
 170     SolarMutexGuard aSolarMutexGuard;
 171
 172     m_xToolbar->SetItemWindow( m_nID, nullptr );
 173     m_pComboBox.disposeAndClear();
 174
 175     ComplexToolbarController::dispose();
 176 }
 177
 178 Sequence<PropertyValue> ComboboxToolbarController::getExecuteArgs(sal_Int16 KeyModifier) const
 179 {
 180     OUString aSelectedText = m_pComboBox->get_active_text();
 181
 182     // Add key modifier to argument list
 183     Sequence<PropertyValue> aArgs{ comphelper::makePropertyValue(u"KeyModifier"_ustr, KeyModifier),
 184                                    comphelper::makePropertyValue(u"Text"_ustr, aSelectedText) };
 185     return aArgs;
 186 }
 187
 188 void ComboboxToolbarController::Select()
 189 {
 190     vcl::Window::PointerState aState = m_pComboBox->GetPointerState();
 191
 192     sal_uInt16 nKeyModifier = sal_uInt16( aState.mnState & KEY_MODIFIERS_MASK );
 193     execute( nKeyModifier );
 194 }
 195
 196 void ComboboxToolbarController::Modify()
 197 {
 198     notifyTextChanged(m_pComboBox->get_active_text());
 199 }
 200
 201 void ComboboxToolbarController::GetFocus()
 202 {
 203     notifyFocusGet();
 204 }
 205
 206 void ComboboxToolbarController::LoseFocus()
 207 {
 208     notifyFocusLost();
 209 }
 210
 211 void ComboboxToolbarController::Activate()
 212 {
 213     // Call execute only with non-empty text
 214     if (!m_pComboBox->get_active_text().isEmpty())
 215         execute(0);
 216 }
 217
 218 void ComboboxToolbarController::executeControlCommand( const css::frame::ControlCommand& rControlCommand )
 219 {
 220     if ( rControlCommand.Command == "SetText" )
 221     {
 222         for ( const NamedValue& rArg : rControlCommand.Arguments )
 223         {
 224             if ( rArg.Name == "Text" )
 225             {
 226                 OUString aText;
 227                 rArg.Value >>= aText;
 228                 m_pComboBox->set_active_or_entry_text(aText);
 229
 230                 // send notification
 231                 notifyTextChanged( aText );
 232                 break;
 233             }
 234         }
 235     }
 236     else if ( rControlCommand.Command == "SetList" )
 237     {
 238         for ( const NamedValue& rArg : rControlCommand.Arguments )
 239         {
 240             if ( rArg.Name == "List" )
 241             {
 242                 Sequence< OUString > aList;
 243                 m_pComboBox->clear();
 244
 245                 rArg.Value >>= aList;
 246                 for (OUString const& rName : aList)
 247                     m_pComboBox->append_text(rName);
 248
 249                 // send notification
 250                 uno::Sequence< beans::NamedValue > aInfo { { u"List"_ustr, css::uno::Any(aList) } };
 251                 addNotifyInfo( u"ListChanged"_ustr,
 252                                getDispatchFromCommand( m_aCommandURL ),
 253                                aInfo );
 254
 255                 break;
 256             }
 257         }
 258     }
 259     else if ( rControlCommand.Command == "AddEntry" )
 260     {
 261         OUString   aText;
 262         for ( const NamedValue& rArg : rControlCommand.Arguments )
 263         {
 264             if ( rArg.Name == "Text" )
 265             {
 266                 if ( rArg.Value >>= aText )
 267                     m_pComboBox->append_text(aText);
 268                 break;
 269             }
 270         }
 271     }
 272     else if ( rControlCommand.Command == "InsertEntry" )
 273     {
 274         sal_Int32 nPos(-1);
 275         OUString   aText;
 276         for ( const NamedValue& rArg : rControlCommand.Arguments )
 277         {
 278             if ( rArg.Name == "Pos" )
 279             {
 280                 sal_Int32 nTmpPos = 0;
 281                 if ( rArg.Value >>= nTmpPos )
 282                 {
 283                     if (( nTmpPos >= 0 ) &&
 284                         ( nTmpPos < m_pComboBox->get_count() ))
 285                         nPos = nTmpPos;
 286                 }
 287             }
 288             else if ( rArg.Name == "Text" )
 289                 rArg.Value >>= aText;
 290         }
 291
 292         m_pComboBox->insert_text(nPos, aText);
 293     }
 294     else if ( rControlCommand.Command == "RemoveEntryPos" )
 295     {
 296         for ( const NamedValue& rArg : rControlCommand.Arguments )
 297         {
 298             if ( rArg.Name == "Pos" )
 299             {
 300                 sal_Int32 nPos( -1 );
 301                 if ( rArg.Value >>= nPos )
 302                 {
 303                     if (0 <= nPos && nPos < m_pComboBox->get_count())
 304                         m_pComboBox->remove(nPos);
 305                 }
 306                 break;
 307             }
 308         }
 309     }
 310     else if ( rControlCommand.Command == "RemoveEntryText" )
 311     {
 312         for ( const NamedValue& rArg : rControlCommand.Arguments )
 313         {
 314             if ( rArg.Name == "Text")
 315             {
 316                 OUString aText;
 317                 if ( rArg.Value >>= aText )
 318                 {
 319                     auto nPos = m_pComboBox->find_text(aText);
 320                     if (nPos != -1)
 321                         m_pComboBox->remove(nPos);
 322                 }
 323                 break;
 324             }
 325         }
 326     }
 327 }
 328
 329 } // namespace
 330
 331 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */