summaryrefslogtreecommitdiff
path: root/sc/source/ui/vba/vbacommandbarcontrol.cxx
blob: fb8fb50caaafa771187134353517d415d8356785 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#include "vbacommandbarcontrol.hxx"

using namespace com::sun::star;
using namespace ooo::vba;

uno::Any lcl_getPropertyValue( beans::PropertyValues aPropertyValues, rtl::OUString sPropertyName )
{
    sal_Int32 nCount = aPropertyValues.getLength();
    for( sal_Int32 i = 0; i < nCount; i++ )
    {
        if( aPropertyValues[i].Name.equalsIgnoreAsciiCase( sPropertyName ) )
        {
            return aPropertyValues[i].Value;
        }
    }
    return uno::Any();
}

beans::PropertyValues lcl_repalcePropertyValue( beans::PropertyValues aPropertyValues, rtl::OUString sPropertyName, uno::Any aValue )
{
    sal_Int32 nCount = aPropertyValues.getLength();
    for( sal_Int32 i = 0; i < nCount; i++ )
    {
        if( aPropertyValues[i].Name.equalsIgnoreAsciiCase( sPropertyName ) )
        {
            aPropertyValues[i].Value = aValue;
            return aPropertyValues;
        }
    }
    return aPropertyValues;
}

ScVbaCommandBarControl::ScVbaCommandBarControl( const uno::Reference< XHelperInterface > xParent, const uno::Reference< uno::XComponentContext > xContext, rtl::OUString sName ) throw (uno::RuntimeException) : CommandBarControl_BASE( xParent, xContext ), m_sName( sName )
{
    // exsiting CommandBarBarControl
    m_xParentHardRef.set( xParent, uno::UNO_QUERY_THROW );
    initObjects();
    if( m_xBarSettings->hasElements() )
    {
        ScVbaCommandBarControl* pParentCommandBarControl = m_pCommandBarControls->GetParentCommandBarControl();
        if( pParentCommandBarControl )
        {
            beans::PropertyValues aPropertyValues;
            pParentCommandBarControl->GetCurrentSettings()->getByIndex( pParentCommandBarControl->GetPosition() ) >>= aPropertyValues;
            pParentCommandBarControl->SetPropertyValues( aPropertyValues );
            m_xCurrentSettings.set( lcl_getPropertyValue( pParentCommandBarControl->GetPropertyValues(), rtl::OUString::createFromAscii( "ItemDescriptorContainer" ) ), uno::UNO_QUERY_THROW );
        }
        if( !m_xCurrentSettings.is() )
        {
            m_xCurrentSettings.set( m_xUICfgManager->getSettings( m_pCommandBarControls->GetParentToolBarName(), sal_True ), uno::UNO_QUERY_THROW );
        }
        for( sal_Int32 i = 0; i < m_xCurrentSettings->getCount(); i++ )
        {
            beans::PropertyValues aPropertyValuesTemp;
            m_xCurrentSettings->getByIndex( i ) >>= aPropertyValuesTemp;
            // Label always empty in OOo
            rtl::OUString sLabel;
            lcl_getPropertyValue( aPropertyValuesTemp, rtl::OUString::createFromAscii( "Label" ) ) >>= sLabel;
            if( sLabel.equalsIgnoreAsciiCase( sName ) )
            {
                m_nPosition = i;
                break;
            }
            // using CammandURL to find
            rtl::OUString sCommandURL;
            lcl_getPropertyValue( aPropertyValuesTemp, rtl::OUString::createFromAscii( "CommandURL" ) ) >>= sCommandURL;
            sal_Int32 nLastIndex = sCommandURL.lastIndexOf( rtl::OUString::createFromAscii(":") );
            if( ( nLastIndex != -1 ) && ( ( nLastIndex + 1 ) < sCommandURL.getLength() ) )
            {
                sCommandURL = sCommandURL.copy( nLastIndex + 1 );
            }
            if( sCommandURL.equalsIgnoreAsciiCase( sName ) )
            {
                m_nPosition = i;
                break;
            }
        }
        if( m_nPosition  == -1 )
            throw uno::RuntimeException( rtl::OUString::createFromAscii("The CommandBarControl do not exist"), uno::Reference< uno::XInterface >() );
    }
    if( m_bIsMenu )
    {
        m_sBarName = rtl::OUString::createFromAscii("private:resource/menubar/menubar");
    }
    else
    {
        m_sBarName = m_pCommandBarControls->GetParentToolBarName();
    }
    m_bTemporary = sal_True;
}
ScVbaCommandBarControl::ScVbaCommandBarControl( const uno::Reference< XHelperInterface > xParent, const uno::Reference< uno::XComponentContext > xContext, rtl::OUString sName, rtl::OUString sCommand, sal_Int32 nPosition, sal_Bool bTemporary ) throw (uno::RuntimeException) :  CommandBarControl_BASE( xParent, xContext ), m_nPosition( nPosition ), m_bTemporary( bTemporary )
{
    m_xParentHardRef.set( xParent, uno::UNO_QUERY_THROW );
    initObjects();
    if( sName.getLength() > 0 )
    {
        m_sName = sName;
    }
    if( sCommand.getLength() > 0 )
    {
        m_sCommand = sCommand;
    }
    else
    {
        m_sCommand = rtl::OUString::createFromAscii("vnd.openoffice.org:") + sName;
    }
    if( m_bIsMenu )
    {
        m_sBarName = rtl::OUString::createFromAscii("private:resource/menubar/menubar");
        createNewMenuBarControl();
    }
    else
    {
        m_sBarName = m_pCommandBarControls->GetParentToolBarName();
        createNewToolBarControl();
    }
}

void
ScVbaCommandBarControl::initObjects() throw (uno::RuntimeException)
{
    m_pCommandBarControls = dynamic_cast< ScVbaCommandBarControls* >( m_xParentHardRef.get() );
    if( !m_pCommandBarControls )
        throw uno::RuntimeException( rtl::OUString::createFromAscii( "Parent needs to be a ScVbaCommandBarControls"), uno::Reference< uno::XInterface >() );
    m_xUICfgManager.set( m_pCommandBarControls->GetUICfgManager(), uno::UNO_QUERY_THROW );
    m_xUICfgPers.set( m_pCommandBarControls->GetUICfgPers(), uno::UNO_QUERY_THROW );
    m_xBarSettings.set( m_pCommandBarControls->GetBarSettings(), uno::UNO_QUERY_THROW );
    m_bIsMenu = m_pCommandBarControls->IsMenu();
    m_sName = rtl::OUString::createFromAscii( "Custom" );
    m_nPosition = -1;
}

void
ScVbaCommandBarControl::createNewMenuBarControl()
{
    uno::Sequence< beans::PropertyValue > aPropertys(4);
    aPropertys[0].Name = rtl::OUString::createFromAscii("CommandURL");
    aPropertys[0].Value <<= m_sCommand; 
    aPropertys[1].Name = rtl::OUString::createFromAscii("Label");
    aPropertys[1].Value <<= m_sName; 
    aPropertys[2].Name = rtl::OUString::createFromAscii("Type");
    aPropertys[2].Value <<= m_nType; 
    aPropertys[3].Name = rtl::OUString::createFromAscii("ItemDescriptorContainer");

    m_xBarSettings->insertByIndex( m_nPosition, uno::makeAny( aPropertys ) );
    uno::Reference< beans::XPropertySet > xPropertySet( m_xBarSettings, uno::UNO_QUERY_THROW );
    rtl::OUString sUIName;
    xPropertySet->getPropertyValue( rtl::OUString::createFromAscii("UIName") ) >>= sUIName;

    uno::Reference< lang::XSingleComponentFactory > xMenuMSF( m_xBarSettings, uno::UNO_QUERY_THROW );
    if( m_pCommandBarControls->GetParentCommandBar() != NULL )
    {
        // create a new menu
        m_xBarSettings->insertByIndex( m_nPosition, uno::makeAny( aPropertys ) );
        m_xCurrentSettings.set( m_xBarSettings, uno::UNO_QUERY_THROW );
    }
    else if( m_pCommandBarControls->GetParentCommandBarControl() != NULL )
    {
        // create a new menu entry
        // change the parent MenuItem to a PopupMenu
        ScVbaCommandBarControl* pPc = m_pCommandBarControls->GetParentCommandBarControl();
        beans::PropertyValues aPropertyValues;
        pPc->GetCurrentSettings()->getByIndex( pPc->GetPosition() ) >>= aPropertyValues;
        pPc->SetPropertyValues( aPropertyValues );
        
        // has the property already been set?
        if( lcl_getPropertyValue( pPc->GetPropertyValues(), rtl::OUString::createFromAscii("ItemDescriptorContainer") ).hasValue() )
        {
            lcl_repalcePropertyValue(  pPc->GetPropertyValues(), rtl::OUString::createFromAscii("ItemDescriptorContainer"), uno::makeAny( xMenuMSF->createInstanceWithContext( mxContext ) ) );
            pPc->GetCurrentSettings()->replaceByIndex( pPc->GetPosition(), uno::makeAny( pPc->GetPropertyValues() ) );
        }
        m_xCurrentSettings.set( lcl_getPropertyValue( pPc->GetPropertyValues(), rtl::OUString::createFromAscii("ItemDescriptorContainer") ), uno::UNO_QUERY_THROW );
        m_xCurrentSettings->insertByIndex( m_nPosition, uno::makeAny( m_aPropertyValues ) );
    }
    if( m_xUICfgManager->hasSettings( m_sBarName ) )
    {
        m_xUICfgManager->replaceSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
    }
    else
    {
        m_xUICfgManager->insertSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
    }
    if( !m_bTemporary )
    {
        m_xUICfgPers->store();
    }
}

void
ScVbaCommandBarControl::createNewToolBarControl()
{
    uno::Sequence< beans::PropertyValue > aPropertys(4);
    aPropertys[0].Name = rtl::OUString::createFromAscii("CommandURL");
    aPropertys[0].Value <<= m_sCommand; 
    aPropertys[1].Name = rtl::OUString::createFromAscii("Label");
    aPropertys[1].Value <<= m_sName; 
    aPropertys[2].Name = rtl::OUString::createFromAscii("Type");
    aPropertys[2].Value <<= m_nType; 
    aPropertys[3].Name = rtl::OUString::createFromAscii("IsVisible");
    aPropertys[3].Value <<= sal_True; 

    m_xBarSettings->insertByIndex( m_nPosition, uno::makeAny( aPropertys ) );
    uno::Reference< beans::XPropertySet > xPropertySet( m_xBarSettings, uno::UNO_QUERY_THROW );
    rtl::OUString sUIName;
    xPropertySet->getPropertyValue( rtl::OUString::createFromAscii("UIName") ) >>= sUIName;

    m_xCurrentSettings.set( m_xBarSettings, uno::UNO_QUERY_THROW );
    if( m_xUICfgManager->hasSettings( m_sBarName ) )
    {
        m_xUICfgManager->replaceSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
    }
    else
    {
        m_xUICfgManager->insertSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
    }
    if( !m_bTemporary )
    {
        m_xUICfgPers->store();
    }
}

::rtl::OUString SAL_CALL
ScVbaCommandBarControl::getCaption() throw ( uno::RuntimeException )
{
    // "Label" always empty
    rtl::OUString sCaption;
    beans::PropertyValues aPropertyValues;
    if( m_xCurrentSettings.is() )
    {
        m_xCurrentSettings->getByIndex( m_nPosition ) >>= aPropertyValues;
        lcl_getPropertyValue( aPropertyValues, rtl::OUString::createFromAscii("Label") ) >>= sCaption;
    }
    else if( m_xBarSettings.is() )
    {
        m_xBarSettings->getByIndex( m_nPosition ) >>= aPropertyValues;
        lcl_getPropertyValue( aPropertyValues, rtl::OUString::createFromAscii("Label") ) >>= sCaption;
    }
    return sCaption;
}
void SAL_CALL 
ScVbaCommandBarControl::setCaption( const ::rtl::OUString& _caption ) throw (uno::RuntimeException)
{
    if( m_xCurrentSettings.is() )
    {
        beans::PropertyValues aPropertyValues;
        m_xCurrentSettings->getByIndex( m_nPosition ) >>= aPropertyValues;
        beans::PropertyValues aNewPropertyValues;
        aNewPropertyValues = lcl_repalcePropertyValue( aPropertyValues, rtl::OUString::createFromAscii("Label"), uno::makeAny( _caption ) );
        m_xCurrentSettings->replaceByIndex( m_nPosition, uno::makeAny( aNewPropertyValues ) );
        if( m_xUICfgManager->hasSettings( m_sBarName ) )
        {
            m_xUICfgManager->replaceSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        else
        {
            m_xUICfgManager->insertSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        // make it permanent
        if( !m_bTemporary )
        {
            m_xUICfgPers->store();
        }
    }
}
::rtl::OUString SAL_CALL 
ScVbaCommandBarControl::getOnAction() throw (uno::RuntimeException)
{
    if( m_xCurrentSettings.is() )
    {
        beans::PropertyValues aPropertyValues;
        m_xCurrentSettings->getByIndex( m_nPosition ) >>= aPropertyValues;
        rtl::OUString sCommandURL;
        lcl_getPropertyValue( aPropertyValues, rtl::OUString::createFromAscii( "CommandURL" ) ) >>= sCommandURL;
        return sCommandURL;
    }
    return ::rtl::OUString();
}
void SAL_CALL 
ScVbaCommandBarControl::setOnAction( const ::rtl::OUString& _onaction ) throw (uno::RuntimeException)
{
    if( m_xCurrentSettings.is() )
    {
        beans::PropertyValues aPropertyValues;
        m_xCurrentSettings->getByIndex( m_nPosition ) >>= aPropertyValues;
        beans::PropertyValues aNewPropertyValues;
        aNewPropertyValues = lcl_repalcePropertyValue( aPropertyValues, rtl::OUString::createFromAscii("CommandURL"), uno::makeAny( _onaction ) );
        m_xCurrentSettings->replaceByIndex( m_nPosition, uno::makeAny( aNewPropertyValues ) );
        if( m_xUICfgManager->hasSettings( m_sBarName ) )
        {
            m_xUICfgManager->replaceSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        else
        {
            m_xUICfgManager->insertSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        // make it permanent
        if( !m_bTemporary )
        {
            m_xUICfgPers->store();
        }
    }
}
::sal_Bool SAL_CALL 
ScVbaCommandBarControl::getVisible() throw (uno::RuntimeException)
{
    // not possible in UNO?
    return sal_True;
}
void SAL_CALL 
ScVbaCommandBarControl::setVisible( ::sal_Bool /*_visible*/ ) throw (uno::RuntimeException)
{
    // "IsVisilbe"
}
void SAL_CALL 
ScVbaCommandBarControl::Delete(  ) throw (css::script::BasicErrorException, css::uno::RuntimeException)
{
    if( m_xCurrentSettings.is() )
    {
        m_xCurrentSettings->removeByIndex( m_nPosition );

        if( m_xUICfgManager->hasSettings( m_sBarName ) )
        {
            m_xUICfgManager->replaceSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        else
        {
            m_xUICfgManager->insertSettings( m_sBarName, uno::Reference< container::XIndexAccess > (m_xBarSettings, uno::UNO_QUERY_THROW ) );
        }
        // make it permanent
        if( !m_bTemporary )
        {
            m_xUICfgPers->store();
        }
    }
}
uno::Any SAL_CALL 
ScVbaCommandBarControl::Controls( const uno::Any& aIndex ) throw (script::BasicErrorException, uno::RuntimeException)
{
    sal_Int32 nIndex;
    uno::Reference< XCommandBarControls > xCommandBarControls( new ScVbaCommandBarControls( this, mxContext, uno::Reference< container::XIndexAccess >() ) );
    if( aIndex.hasValue() )
    {
        if( aIndex >>= nIndex )
        {
            uno::Reference< XCommandBarControl > xCommandBarControl( xCommandBarControls->Item( aIndex, uno::Any() ), uno::UNO_QUERY_THROW );
            return uno::makeAny( xCommandBarControl );
        }
        else
            throw uno::RuntimeException( rtl::OUString::createFromAscii( "invalid index" ), uno::Reference< uno::XInterface >() );
    }
    return uno::makeAny( xCommandBarControls );
}
rtl::OUString& 
ScVbaCommandBarControl::getServiceImplName()
{
    static rtl::OUString sImplName( RTL_CONSTASCII_USTRINGPARAM("ScVbaCommandBarControl") );
    return sImplName;
}
uno::Sequence<rtl::OUString> 
ScVbaCommandBarControl::getServiceNames()
{
    static uno::Sequence< rtl::OUString > aServiceNames;
    if ( aServiceNames.getLength() == 0 )
    {
        aServiceNames.realloc( 1 );
        aServiceNames[ 0 ] = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ooo.vba.CommandBarControl" ) );
    }
    return aServiceNames;
}