framework/source/uielement/comboboxtoolbarcontroller.cxx

   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: comboboxtoolbarcontroller.cxx,v $
  10  * $Revision: 1.11 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_framework.hxx"
  33
  34 #ifndef __FRAMEWORK_UIELEMENT_COMBOBOXTOOLBARCONTROLLER_HXX
  35 #include "uielement/comboboxtoolbarcontroller.hxx"
  36 #endif
  37
  38 //_________________________________________________________________________________________________________________
  39 //      my own includes
  40 //_________________________________________________________________________________________________________________
  41
  42 #ifndef __FRAMEWORK_TOOLBAR_HXX_
  43 #include "uielement/toolbar.hxx"
  44 #endif
  45
  46 //_________________________________________________________________________________________________________________
  47 //      interface includes
  48 //_________________________________________________________________________________________________________________
  49 #include <com/sun/star/util/XURLTransformer.hpp>
  50 #include <com/sun/star/frame/XDispatchProvider.hpp>
  51 #include <com/sun/star/beans/PropertyValue.hpp>
  52 #include <com/sun/star/lang/DisposedException.hpp>
  53 #include <com/sun/star/frame/status/ItemStatus.hpp>
  54 #include <com/sun/star/frame/status/ItemState.hpp>
  55 #include <com/sun/star/frame/status/Visibility.hpp>
  56 #include <com/sun/star/frame/XControlNotificationListener.hpp>
  57 #include <com/sun/star/util/Color.hpp>
  58
  59 //_________________________________________________________________________________________________________________
  60 //      other includes
  61 //_________________________________________________________________________________________________________________
  62 #include <svtools/toolboxcontroller.hxx>
  63 #include <vos/mutex.hxx>
  64 #include <vcl/svapp.hxx>
  65 #ifndef _VCL_MNEMONIC_HXX_
  66 #include <vcl/mnemonic.hxx>
  67 #endif
  68 #include <vcl/toolbox.hxx>
  69 #include <vcl/combobox.hxx>
  70 #include <tools/urlobj.hxx>
  71
  72 using namespace ::com::sun::star;
  73 using namespace ::com::sun::star::uno;
  74 using namespace ::com::sun::star::beans;
  75 using namespace ::com::sun::star::lang;
  76 using namespace ::com::sun::star::frame;
  77 using namespace ::com::sun::star::frame::status;
  78 using namespace ::com::sun::star::util;
  79
  80 namespace framework
  81 {
  82
  83 // ------------------------------------------------------------------
  84
  85 // Wrapper class to notify controller about events from combobox.
  86 // Unfortunaltly the events are notifed through virtual methods instead
  87 // of Listeners.
  88
  89 class ComboBoxControl : public ComboBox
  90 {
  91     public:
  92         ComboBoxControl( Window* pParent, WinBits nStyle, IComboBoxListener* pComboBoxListener );
  93         virtual ~ComboBoxControl();
  94
  95         virtual void Select();
  96         virtual void DoubleClick();
  97         virtual void Modify();
  98         virtual void KeyInput( const ::KeyEvent& rKEvt );
  99         virtual void GetFocus();
 100         virtual void LoseFocus();
 101         virtual long PreNotify( NotifyEvent& rNEvt );
 102
 103     private:
 104         IComboBoxListener* m_pComboBoxListener;
 105 };
 106
 107 ComboBoxControl::ComboBoxControl( Window* pParent, WinBits nStyle, IComboBoxListener* pComboBoxListener ) :
 108     ComboBox( pParent, nStyle )
 109     , m_pComboBoxListener( pComboBoxListener )
 110 {
 111 }
 112
 113 ComboBoxControl::~ComboBoxControl()
 114 {
 115     m_pComboBoxListener = 0;
 116 }
 117
 118 void ComboBoxControl::Select()
 119 {
 120     ComboBox::Select();
 121     if ( m_pComboBoxListener )
 122         m_pComboBoxListener->Select();
 123 }
 124
 125 void ComboBoxControl::DoubleClick()
 126 {
 127     ComboBox::DoubleClick();
 128     if ( m_pComboBoxListener )
 129         m_pComboBoxListener->DoubleClick();
 130 }
 131
 132 void ComboBoxControl::Modify()
 133 {
 134     ComboBox::Modify();
 135     if ( m_pComboBoxListener )
 136         m_pComboBoxListener->Modify();
 137 }
 138
 139 void ComboBoxControl::KeyInput( const ::KeyEvent& rKEvt )
 140 {
 141     ComboBox::KeyInput( rKEvt );
 142     if ( m_pComboBoxListener )
 143         m_pComboBoxListener->KeyInput( rKEvt );
 144 }
 145
 146 void ComboBoxControl::GetFocus()
 147 {
 148     ComboBox::GetFocus();
 149     if ( m_pComboBoxListener )
 150         m_pComboBoxListener->GetFocus();
 151 }
 152
 153 void ComboBoxControl::LoseFocus()
 154 {
 155     ComboBox::LoseFocus();
 156     if ( m_pComboBoxListener )
 157         m_pComboBoxListener->LoseFocus();
 158 }
 159
 160 long ComboBoxControl::PreNotify( NotifyEvent& rNEvt )
 161 {
 162     long nRet( 0 );
 163     if ( m_pComboBoxListener )
 164         nRet = m_pComboBoxListener->PreNotify( rNEvt );
 165     if ( nRet == 0 )
 166         nRet = ComboBox::PreNotify( rNEvt );
 167
 168     return nRet;
 169 }
 170
 171 // ------------------------------------------------------------------
 172
 173 ComboboxToolbarController::ComboboxToolbarController(
 174     const Reference< XMultiServiceFactory >& rServiceManager,
 175     const Reference< XFrame >&               rFrame,
 176     ToolBox*                                 pToolbar,
 177     USHORT                                   nID,
 178     sal_Int32                                nWidth,
 179     const ::rtl::OUString&                          aCommand ) :
 180     ComplexToolbarController( rServiceManager, rFrame, pToolbar, nID, aCommand )
 181     ,   m_pComboBox( 0 )
 182 {
 183     m_pComboBox = new ComboBoxControl( m_pToolbar, WB_DROPDOWN, this );
 184     if ( nWidth == 0 )
 185         nWidth = 100;
 186
 187     // default dropdown size
 188     ::Size aLogicalSize( 8, 160 );
 189     ::Size aPixelSize = m_pComboBox->LogicToPixel( aLogicalSize, MAP_APPFONT );
 190
 191     m_pComboBox->SetSizePixel( ::Size( nWidth, aPixelSize.Height() ));
 192     m_pToolbar->SetItemWindow( m_nID, m_pComboBox );
 193 }
 194
 195 // ------------------------------------------------------------------
 196
 197 ComboboxToolbarController::~ComboboxToolbarController()
 198 {
 199 }
 200
 201 // ------------------------------------------------------------------
 202
 203 void SAL_CALL ComboboxToolbarController::dispose()
 204 throw ( RuntimeException )
 205 {
 206     vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
 207
 208     m_pToolbar->SetItemWindow( m_nID, 0 );
 209     delete m_pComboBox;
 210
 211     ComplexToolbarController::dispose();
 212
 213     m_pComboBox = 0;
 214 }
 215
 216 // ------------------------------------------------------------------
 217 Sequence<PropertyValue> ComboboxToolbarController::getExecuteArgs(sal_Int16 KeyModifier) const
 218 {
 219     Sequence<PropertyValue> aArgs( 2 );
 220     ::rtl::OUString aSelectedText = m_pComboBox->GetText();
 221
 222     // Add key modifier to argument list
 223     aArgs[0].Name = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "KeyModifier" ));
 224     aArgs[0].Value <<= KeyModifier;
 225     aArgs[1].Name = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Text" ));
 226     aArgs[1].Value <<= aSelectedText;
 227     return aArgs;
 228 }
 229
 230 // ------------------------------------------------------------------
 231
 232 void ComboboxToolbarController::Select()
 233 {
 234     if ( m_pComboBox->GetEntryCount() > 0 )
 235     {
 236         Window::PointerState aState = m_pComboBox->GetPointerState();
 237
 238         sal_uInt16 nKeyModifier = sal_uInt16( aState.mnState & KEY_MODTYPE );
 239         execute( nKeyModifier );
 240     }
 241 }
 242
 243 void ComboboxToolbarController::DoubleClick()
 244 {
 245 }
 246
 247 void ComboboxToolbarController::Modify()
 248 {
 249     notifyTextChanged( m_pComboBox->GetText() );
 250 }
 251
 252 void ComboboxToolbarController::KeyInput( const ::KeyEvent& )
 253 {
 254 }
 255
 256 void ComboboxToolbarController::GetFocus()
 257 {
 258     notifyFocusGet();
 259 }
 260
 261 void ComboboxToolbarController::LoseFocus()
 262 {
 263     notifyFocusLost();
 264 }
 265
 266 long ComboboxToolbarController::PreNotify( NotifyEvent& rNEvt )
 267 {
 268     if( rNEvt.GetType() == EVENT_KEYINPUT )
 269     {
 270         const ::KeyEvent* pKeyEvent = rNEvt.GetKeyEvent();
 271         const KeyCode& rKeyCode = pKeyEvent->GetKeyCode();
 272         if(( rKeyCode.GetModifier() | rKeyCode.GetCode()) == KEY_RETURN )
 273         {
 274             // Call execute only with non-empty text
 275             if ( m_pComboBox->GetText().Len() > 0 )
 276                 execute( rKeyCode.GetModifier() );
 277             return 1;
 278         }
 279     }
 280
 281     return 0;
 282 }
 283
 284 // --------------------------------------------------------
 285
 286 void ComboboxToolbarController::executeControlCommand( const ::com::sun::star::frame::ControlCommand& rControlCommand )
 287 {
 288     if ( rControlCommand.Command.equalsAsciiL( "SetText", 7 ))
 289     {
 290         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 291         {
 292             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Text", 4 ))
 293             {
 294                 rtl::OUString aText;
 295                 rControlCommand.Arguments[i].Value >>= aText;
 296                 m_pComboBox->SetText( aText );
 297
 298                 // send notification
 299                 notifyTextChanged( aText );
 300                 break;
 301             }
 302         }
 303     }
 304     else if ( rControlCommand.Command.equalsAsciiL( "SetList", 7 ))
 305     {
 306         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 307         {
 308             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "List", 4 ))
 309             {
 310                 Sequence< ::rtl::OUString > aList;
 311                 m_pComboBox->Clear();
 312
 313                 rControlCommand.Arguments[i].Value >>= aList;
 314                 for ( sal_Int32 j = 0; j < aList.getLength(); j++ )
 315                     m_pComboBox->InsertEntry( aList[j] );
 316
 317                 // send notification
 318                 uno::Sequence< beans::NamedValue > aInfo( 1 );
 319                 aInfo[0].Name  = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "List" ));
 320                 aInfo[0].Value <<= aList;
 321                 addNotifyInfo( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ListChanged" )),
 322                                getDispatchFromCommand( m_aCommandURL ),
 323                                aInfo );
 324
 325                 break;
 326             }
 327         }
 328     }
 329     else if ( rControlCommand.Command.equalsAsciiL( "AddEntry", 8 ))
 330     {
 331         sal_uInt16      nPos( COMBOBOX_APPEND );
 332         rtl::OUString   aText;
 333         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 334         {
 335             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Text", 4 ))
 336             {
 337                 if ( rControlCommand.Arguments[i].Value >>= aText )
 338                     m_pComboBox->InsertEntry( aText, nPos );
 339                 break;
 340             }
 341         }
 342     }
 343     else if ( rControlCommand.Command.equalsAsciiL( "InsertEntry", 11 ))
 344     {
 345         sal_uInt16      nPos( COMBOBOX_APPEND );
 346         rtl::OUString   aText;
 347         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 348         {
 349             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Pos", 3 ))
 350             {
 351                 sal_Int32 nTmpPos = 0;
 352                 if ( rControlCommand.Arguments[i].Value >>= nTmpPos )
 353                 {
 354                     if (( nTmpPos >= 0 ) &&
 355                         ( nTmpPos < sal_Int32( m_pComboBox->GetEntryCount() )))
 356                         nPos = sal_uInt16( nTmpPos );
 357                 }
 358             }
 359             else if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Text", 4 ))
 360                 rControlCommand.Arguments[i].Value >>= aText;
 361         }
 362
 363         m_pComboBox->InsertEntry( aText, nPos );
 364     }
 365     else if ( rControlCommand.Command.equalsAsciiL( "RemoveEntryPos", 14 ))
 366     {
 367         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 368         {
 369             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Pos", 3 ))
 370             {
 371                 sal_Int32 nPos( -1 );
 372                 if ( rControlCommand.Arguments[i].Value >>= nPos )
 373                 {
 374                     if ( nPos < sal_Int32( m_pComboBox->GetEntryCount() ))
 375                         m_pComboBox->RemoveEntry( sal_uInt16( nPos ));
 376                 }
 377                 break;
 378             }
 379         }
 380     }
 381     else if ( rControlCommand.Command.equalsAsciiL( "RemoveEntryText", 15 ))
 382     {
 383         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 384         {
 385             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Text", 4 ))
 386             {
 387                 rtl::OUString aText;
 388                 if ( rControlCommand.Arguments[i].Value >>= aText )
 389                     m_pComboBox->RemoveEntry( aText );
 390                 break;
 391             }
 392         }
 393     }
 394     else if ( rControlCommand.Command.equalsAsciiL( "SetDropDownLines", 16 ))
 395     {
 396         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 397         {
 398             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Lines", 5 ))
 399             {
 400                 sal_Int32 nValue( 5 );
 401                 rControlCommand.Arguments[i].Value >>= nValue;
 402                 m_pComboBox->SetDropDownLineCount( sal_uInt16( nValue ));
 403                 break;
 404             }
 405         }
 406     }
 407     else if ( rControlCommand.Command.equalsAsciiL( "SetBackgroundColor", 18 ))
 408     {
 409         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 410         {
 411             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Color", 5 ))
 412             {
 413                 com::sun::star::util::Color aColor(0);
 414                 if ( rControlCommand.Arguments[i].Value >>= aColor )
 415                 {
 416                     ::Color aBackColor( static_cast< UINT32 >( aColor ));
 417                     m_pComboBox->SetControlBackground( aBackColor );
 418                 }
 419                 break;
 420             }
 421         }
 422     }
 423     else if ( rControlCommand.Command.equalsAsciiL( "SetTextColor", 12 ))
 424     {
 425         for ( sal_Int32 i = 0; i < rControlCommand.Arguments.getLength(); i++ )
 426         {
 427             if ( rControlCommand.Arguments[i].Name.equalsAsciiL( "Color", 5 ))
 428             {
 429                 com::sun::star::util::Color aColor(0);
 430                 if ( rControlCommand.Arguments[i].Value >>= aColor )
 431                 {
 432                     ::Color aForeColor( static_cast< UINT32 >( aColor ));
 433                     m_pComboBox->SetControlForeground( aForeColor );
 434                 }
 435                 break;
 436             }
 437         }
 438     }
 439 }
 440
 441 } // namespace
 442