svx/source/tbxctrls/lboxctrl.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: lboxctrl.cxx,v $
  10  * $Revision: 1.29 $
  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_svx.hxx"
  33
  34 #ifdef   _TOOLS_DEBUG_HXX
  35 #include <tools/debug.hxx>
  36 #endif
  37 #include <vcl/lstbox.hxx>
  38 #include <vcl/toolbox.hxx>
  39 #include <vcl/event.hxx>
  40 #include <sfx2/app.hxx>
  41 #include <sfx2/tbxctrl.hxx>
  42 #include <sfx2/bindings.hxx>
  43 #include <sfx2/dispatch.hxx>
  44 #include <sfx2/viewsh.hxx>
  45 #include <tools/gen.hxx>
  46 #include <svtools/intitem.hxx>
  47 #include <svtools/eitem.hxx>
  48 #include <svtools/stdctrl.hxx>
  49 #include <svtools/slstitm.hxx>
  50 #include <svtools/stritem.hxx>
  51 #include <svx/dialmgr.hxx>
  52 #include <lboxctrl.hxx>
  53 #ifndef _VCL_MNEMONIC_HXX_
  54 #include <vcl/mnemonic.hxx>
  55 #endif
  56 #include <tools/urlobj.hxx>
  57
  58 #include <svx/svxids.hrc>
  59 #include <svx/dialogs.hrc>
  60
  61 #include "lboxctrl.hrc"
  62
  63
  64 using namespace ::com::sun::star::uno;
  65 using namespace ::com::sun::star::beans;
  66 using namespace ::com::sun::star::frame;
  67
  68 class SvxPopupWindowListBox;
  69
  70 /////////////////////////////////////////////////////////////////
  71
  72 class SvxPopupWindowListBox : public SfxPopupWindow
  73 {
  74     using FloatingWindow::StateChanged;
  75
  76     FixedInfo           aInfo;
  77     ListBox     *               pListBox;
  78     ToolBox &           rToolBox;
  79     BOOL                        bUserSel;
  80     USHORT          nTbxId;
  81     rtl::OUString   maCommandURL;
  82     // disallow copy-constructor and assignment-operator
  83
  84     SvxPopupWindowListBox(const int& );
  85     SvxPopupWindowListBox & operator = (const int& );
  86
  87 //      SvxPopupWindowListBox( USHORT nSlotId, ToolBox& rTbx, USHORT nTbxItemId );
  88
  89 public:
  90     SvxPopupWindowListBox( USHORT nSlotId, const rtl::OUString& rCommandURL, USHORT nTbxId, ToolBox& rTbx );
  91     virtual ~SvxPopupWindowListBox();
  92
  93     // SfxPopupWindow
  94     virtual SfxPopupWindow *    Clone() const;
  95     virtual void                                PopupModeEnd();
  96     virtual void                                StateChanged( USHORT nSID, SfxItemState eState,
  97                                               const SfxPoolItem* pState );
  98
  99     void                                                StartSelection();
 100     inline ListBox &                    GetListBox()    { return *pListBox; }
 101     inline FixedInfo &                  GetInfo()               { return aInfo; }
 102
 103     BOOL                                                IsUserSelected() const                  { return bUserSel; }
 104     void                                                SetUserSelected( BOOL bVal )    { bUserSel = bVal; }
 105     /*virtual*/Window*                     GetPreferredKeyInputWindow();
 106 };
 107
 108 /////////////////////////////////////////////////////////////////
 109
 110 SvxPopupWindowListBox::SvxPopupWindowListBox( USHORT nSlotId, const rtl::OUString& rCommandURL, USHORT nId, ToolBox& rTbx ) :
 111     SfxPopupWindow( nSlotId, Reference< XFrame >(), SVX_RES( RID_SVXTBX_UNDO_REDO_CTRL ) ),
 112     aInfo               ( this, SVX_RES( FT_NUM_OPERATIONS ) ),
 113     rToolBox    ( rTbx ),
 114     bUserSel    ( FALSE ),
 115     nTbxId      ( nId ),
 116     maCommandURL( rCommandURL )
 117 {
 118     DBG_ASSERT( nSlotId == GetId(), "id mismatch" );
 119     pListBox = new ListBox( this, SVX_RES( LB_SVXTBX_UNDO_REDO_CTRL ) );
 120     FreeResource();
 121     pListBox->EnableMultiSelection( TRUE, TRUE );
 122     SetBackground( GetSettings().GetStyleSettings().GetDialogColor() );
 123     AddStatusListener( rCommandURL );
 124 }
 125
 126
 127 SvxPopupWindowListBox::~SvxPopupWindowListBox()
 128 {
 129     delete pListBox;
 130 }
 131
 132
 133 SfxPopupWindow* SvxPopupWindowListBox::Clone() const
 134 {
 135     return new SvxPopupWindowListBox( GetId(), maCommandURL, nTbxId, rToolBox );
 136 }
 137
 138
 139 void SvxPopupWindowListBox::PopupModeEnd()
 140 {
 141     rToolBox.EndSelection();
 142     SfxPopupWindow::PopupModeEnd();
 143     //FloatingWindow::PopupModeEnd();
 144
 145     if( SfxViewShell::Current() )
 146     {
 147         Window* pShellWnd = SfxViewShell::Current()->GetWindow();
 148         if (pShellWnd)
 149             pShellWnd->GrabFocus();
 150     }
 151 }
 152
 153
 154 void SvxPopupWindowListBox::StateChanged(
 155         USHORT nSID, SfxItemState eState, const SfxPoolItem* pState )
 156 {
 157     rToolBox.EnableItem( nTbxId, ( SfxToolBoxControl::GetItemState( pState ) != SFX_ITEM_DISABLED) );
 158     SfxPopupWindow::StateChanged( nSID, eState, pState );
 159 }
 160
 161
 162 void SvxPopupWindowListBox::StartSelection()
 163 {
 164     rToolBox.StartSelection();
 165 }
 166
 167 Window* SvxPopupWindowListBox::GetPreferredKeyInputWindow()
 168 {
 169     // allows forwarding key events in the correct window
 170     // without setting the focus
 171     return pListBox->GetPreferredKeyInputWindow();
 172 }
 173
 174 /////////////////////////////////////////////////////////////////
 175
 176 SFX_IMPL_TOOLBOX_CONTROL( SvxListBoxControl, SfxStringItem );
 177
 178
 179 SvxListBoxControl::SvxListBoxControl( USHORT nSlotId, USHORT nId, ToolBox& rTbx )
 180     :SfxToolBoxControl( nSlotId, nId, rTbx ),
 181     pPopupWin   ( 0 )
 182 {
 183     rTbx.SetItemBits( nId, TIB_DROPDOWN | rTbx.GetItemBits( nId ) );
 184     rTbx.Invalidate();
 185 }
 186
 187
 188 SvxListBoxControl::~SvxListBoxControl()
 189 {
 190 }
 191
 192
 193 SfxPopupWindow* SvxListBoxControl::CreatePopupWindow()
 194 {
 195     DBG_ERROR( "not implemented" );
 196     return 0;
 197 }
 198
 199
 200 SfxPopupWindowType SvxListBoxControl::GetPopupWindowType() const
 201 {
 202     return SFX_POPUPWINDOW_ONTIMEOUT;
 203 }
 204
 205
 206 void SvxListBoxControl::StateChanged(
 207         USHORT, SfxItemState, const SfxPoolItem* pState )
 208 {
 209     GetToolBox().EnableItem( GetId(),
 210                             SFX_ITEM_DISABLED != GetItemState(pState) );
 211 }
 212
 213
 214 IMPL_LINK( SvxListBoxControl, PopupModeEndHdl, void *, EMPTYARG )
 215 {
 216     if( pPopupWin && 0 == pPopupWin->GetPopupModeFlags()  &&
 217         pPopupWin->IsUserSelected() )
 218     {
 219         USHORT nCount = pPopupWin->GetListBox().GetSelectEntryCount();
 220
 221         INetURLObject aObj( m_aCommandURL );
 222
 223         Sequence< PropertyValue > aArgs( 1 );
 224         aArgs[0].Name   = aObj.GetURLPath();
 225         aArgs[0].Value  = makeAny( sal_Int16( nCount ));
 226         SfxToolBoxControl::Dispatch( m_aCommandURL, aArgs );
 227     }
 228     return 0;
 229 }
 230
 231
 232 void SvxListBoxControl::Impl_SetInfo( USHORT nCount )
 233 {
 234     DBG_ASSERT( pPopupWin, "NULL pointer, PopupWindow missing" );
 235
 236 //    ListBox &rListBox = pPopupWin->GetListBox();
 237
 238     USHORT nId;
 239     if (nCount == 1)
 240         nId = SID_UNDO == GetSlotId() ? RID_SVXSTR_NUM_UNDO_ACTION : RID_SVXSTR_NUM_REDO_ACTION;
 241     else
 242         nId = SID_UNDO == GetSlotId() ? RID_SVXSTR_NUM_UNDO_ACTIONS : RID_SVXSTR_NUM_REDO_ACTIONS;
 243
 244     aActionStr = String(SVX_RES(nId));
 245
 246     String aText( aActionStr );
 247     aText.SearchAndReplaceAllAscii( "$(ARG1)", String::CreateFromInt32( nCount ) );
 248     pPopupWin->GetInfo().SetText( aText );
 249 }
 250
 251
 252 IMPL_LINK( SvxListBoxControl, SelectHdl, void *, EMPTYARG )
 253 {
 254     if (pPopupWin)
 255     {
 256         //pPopupWin->SetUserSelected( FALSE );
 257
 258         ListBox &rListBox = pPopupWin->GetListBox();
 259         if (rListBox.IsTravelSelect())
 260             Impl_SetInfo( rListBox.GetSelectEntryCount() );
 261         else
 262         {
 263             pPopupWin->SetUserSelected( TRUE );
 264             pPopupWin->EndPopupMode( 0 );
 265         }
 266     }
 267     return 0;
 268 }
 269
 270 /////////////////////////////////////////////////////////////////
 271
 272 SFX_IMPL_TOOLBOX_CONTROL( SvxUndoRedoControl, SfxStringItem );
 273
 274 SvxUndoRedoControl::SvxUndoRedoControl( USHORT nSlotId, USHORT nId, ToolBox& rTbx )
 275     : SvxListBoxControl( nSlotId, nId, rTbx )
 276 {
 277     rTbx.SetItemBits( nId, TIB_DROPDOWN | rTbx.GetItemBits( nId ) );
 278     rTbx.Invalidate();
 279     aDefaultText = MnemonicGenerator::EraseAllMnemonicChars( rTbx.GetItemText( nId ) );
 280 }
 281
 282 SvxUndoRedoControl::~SvxUndoRedoControl()
 283 {
 284 }
 285
 286 void SvxUndoRedoControl::StateChanged(
 287     USHORT nSID, SfxItemState eState, const SfxPoolItem* pState )
 288 {
 289     if ( nSID == SID_UNDO || nSID == SID_REDO )
 290     {
 291         if ( eState == SFX_ITEM_DISABLED )
 292         {
 293             ToolBox& rBox = GetToolBox();
 294             rBox.SetQuickHelpText( GetId(), aDefaultText );
 295         }
 296         else if ( pState && pState->ISA( SfxStringItem ) )
 297         {
 298             SfxStringItem& rItem = *(SfxStringItem *)pState;
 299             ToolBox& rBox = GetToolBox();
 300             String aQuickHelpText = MnemonicGenerator::EraseAllMnemonicChars( rItem.GetValue() );
 301             rBox.SetQuickHelpText( GetId(), aQuickHelpText );
 302         }
 303         SvxListBoxControl::StateChanged( nSID, eState, pState );
 304     }
 305     else
 306     {
 307         aUndoRedoList.clear();
 308
 309         if ( pState && pState->ISA( SfxStringListItem ) )
 310         {
 311             SfxStringListItem &rItem = *(SfxStringListItem *)pState;
 312             const List* pLst = rItem.GetList();
 313             DBG_ASSERT( pLst, "no undo actions available" );
 314             if ( pLst )
 315             {
 316                 for( long nI = 0, nEnd = pLst->Count(); nI < nEnd; ++nI )
 317                     aUndoRedoList.push_back( rtl::OUString( *(String *)pLst->GetObject( nI )));
 318             }
 319         }
 320     }
 321 }
 322
 323 SfxPopupWindow* SvxUndoRedoControl::CreatePopupWindow()
 324 {
 325     DBG_ASSERT(( SID_UNDO == GetSlotId() || SID_REDO == GetSlotId() ), "mismatching ids" );
 326
 327     if ( m_aCommandURL.equalsAscii( ".uno:Undo" ))
 328         updateStatus( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ".uno:GetUndoStrings" )));
 329     else
 330         updateStatus( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ".uno:GetRedoStrings" )));
 331
 332     ToolBox& rBox = GetToolBox();
 333
 334     pPopupWin = new SvxPopupWindowListBox( GetSlotId(), m_aCommandURL, GetId(), rBox );
 335     pPopupWin->SetPopupModeEndHdl( LINK( this, SvxUndoRedoControl,
 336                                             PopupModeEndHdl ) );
 337     ListBox &rListBox = pPopupWin->GetListBox();
 338     rListBox.SetSelectHdl( LINK( this, SvxUndoRedoControl, SelectHdl ) );
 339
 340     for( sal_uInt32 n = 0; n < aUndoRedoList.size(); n++ )
 341         rListBox.InsertEntry( String( aUndoRedoList[n] ));
 342
 343     rListBox.SelectEntryPos( 0 );
 344     aActionStr = String( SVX_RES( SID_UNDO == GetSlotId() ?
 345                                   RID_SVXSTR_NUM_UNDO_ACTIONS : RID_SVXSTR_NUM_REDO_ACTIONS ) );
 346     Impl_SetInfo( rListBox.GetSelectEntryCount() );
 347
 348     // move focus in floating window without
 349     // closing it (GrabFocus() would close it!)
 350     pPopupWin->StartPopupMode( &rBox, FLOATWIN_POPUPMODE_GRABFOCUS );
 351     //pPopupWin->GetListBox().GrabFocus();
 352
 353     return pPopupWin;
 354 }