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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_sfx2.hxx"
#include <com/sun/star/frame/DispatchStatement.hpp>
#include <com/sun/star/container/XIndexReplace.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
#include <svl/itemiter.hxx>
#include <svl/itempool.hxx>
#include <svtools/itemdel.hxx>
#include <comphelper/processfactory.hxx>
#include <svl/smplhint.hxx>
#include <sfx2/request.hxx>
#include <sfx2/dispatch.hxx>
#include <sfx2/msg.hxx>
#include <sfx2/viewfrm.hxx>
#include "macro.hxx"
#include <sfx2/objface.hxx>
#include <sfx2/appuno.hxx>
#include <rtl/strbuf.hxx>
//===================================================================
using namespace ::com::sun::star;
struct SfxRequest_Impl: public SfxListener
/* [Description]
Implementation structur of the <SfxRequest> class.
*/
{
SfxRequest* pAnti; // Owner because of dying pool
String aTarget; // if possible from target object set by App
SfxItemPool* pPool; // ItemSet build with this pool
SfxPoolItem* pRetVal; // Return value belongs to itself
SfxShell* pShell; // run from this shell
const SfxSlot* pSlot; // executed Slot
sal_uInt16 nModifier; // which Modifier was pressed?
sal_Bool bDone; // at all executed
sal_Bool bIgnored; // Cancelled by the User
sal_Bool bCancelled; // no longer notify
sal_Bool bUseTarget; // aTarget was set by Application
sal_uInt16 nCallMode; // Synch/Asynch/API/Record
sal_Bool bAllowRecording;
SfxAllItemSet* pInternalArgs;
SfxViewFrame* pViewFrame;
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > xRecorder;
SfxRequest_Impl( SfxRequest *pOwner )
: pAnti( pOwner)
, pPool(0)
, nModifier(0)
, bCancelled(sal_False)
, nCallMode( SFX_CALLMODE_SYNCHRON )
, bAllowRecording( sal_False )
, pInternalArgs( 0 )
, pViewFrame(0)
{}
~SfxRequest_Impl() { delete pInternalArgs; }
void SetPool( SfxItemPool *pNewPool );
virtual void Notify( SfxBroadcaster &rBC, const SfxHint &rHint );
void Record( const uno::Sequence < beans::PropertyValue >& rArgs );
};
//====================================================================
void SfxRequest_Impl::Notify( SfxBroadcaster&, const SfxHint &rHint )
{
SfxSimpleHint *pSimpleHint = PTR_CAST(SfxSimpleHint, &rHint);
if ( pSimpleHint && pSimpleHint->GetId() == SFX_HINT_DYING )
pAnti->Cancel();
}
//====================================================================
void SfxRequest_Impl::SetPool( SfxItemPool *pNewPool )
{
if ( pNewPool != pPool )
{
if ( pPool )
EndListening( pPool->BC() );
pPool = pNewPool;
if ( pNewPool )
StartListening( pNewPool->BC() );
}
}
//====================================================================
SfxRequest::~SfxRequest()
{
DBG_MEMTEST();
// Leave out Done() marked requests with 'rem'
if ( pImp->xRecorder.is() && !pImp->bDone && !pImp->bIgnored )
pImp->Record( uno::Sequence < beans::PropertyValue >() );
// Clear object
delete pArgs;
if ( pImp->pRetVal )
DeleteItemOnIdle(pImp->pRetVal);
delete pImp;
}
//--------------------------------------------------------------------
SfxRequest::SfxRequest
(
const SfxRequest& rOrig
)
: SfxHint( rOrig ),
nSlot(rOrig.nSlot),
pArgs(rOrig.pArgs? new SfxAllItemSet(*rOrig.pArgs): 0),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bAllowRecording = rOrig.pImp->bAllowRecording;
pImp->bDone = sal_False;
pImp->bIgnored = sal_False;
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = rOrig.pImp->nCallMode;
pImp->bUseTarget = rOrig.pImp->bUseTarget;
pImp->aTarget = rOrig.pImp->aTarget;
pImp->nModifier = rOrig.pImp->nModifier;
// deep copy needed !
pImp->pInternalArgs = (rOrig.pImp->pInternalArgs ? new SfxAllItemSet(*rOrig.pImp->pInternalArgs) : 0);
if ( pArgs )
pImp->SetPool( pArgs->GetPool() );
else
pImp->SetPool( rOrig.pImp->pPool );
}
//--------------------------------------------------------------------
SfxRequest::SfxRequest
(
SfxViewFrame* pViewFrame,
sal_uInt16 nSlotId
)
/* [Description]
With this constructor events can subsequently be recorded that are not run
across SfxDispatcher (eg from KeyInput() or mouse events). For this, a
SfxRequest instance is created by this constructor and then proceed
exactly as with a SfxRequest that in a <Slot-Execute-Method> is given as a
parameter.
*/
: nSlot(nSlotId),
pArgs(0),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = sal_False;
pImp->bIgnored = sal_False;
pImp->SetPool( &pViewFrame->GetPool() );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = SFX_CALLMODE_SYNCHRON;
pImp->bUseTarget = sal_False;
pImp->pViewFrame = pViewFrame;
if( pImp->pViewFrame->GetDispatcher()->GetShellAndSlot_Impl( nSlotId, &pImp->pShell, &pImp->pSlot, sal_True, sal_True ) )
{
pImp->SetPool( &pImp->pShell->GetPool() );
pImp->xRecorder = SfxRequest::GetMacroRecorder( pViewFrame );
pImp->aTarget = pImp->pShell->GetName();
}
#ifdef DBG_UTIL
else
{
rtl::OStringBuffer aStr(RTL_CONSTASCII_STRINGPARAM(
"Recording unsupported slot: "));
aStr.append(static_cast<sal_Int32>(pImp->pPool->GetSlotId(nSlotId)));
OSL_FAIL(aStr.getStr());
}
#endif
}
//--------------------------------------------------------------------
SfxRequest::SfxRequest
(
sal_uInt16 nSlotId, // executed <Slot-Id>
SfxCallMode nMode, // Synch/API/...
SfxItemPool& rPool // necessary for the SfxItemSet for parameters
)
// creates a SfxRequest without arguments
: nSlot(nSlotId),
pArgs(0),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = sal_False;
pImp->bIgnored = sal_False;
pImp->SetPool( &rPool );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = sal_False;
}
SfxRequest::SfxRequest
(
const SfxSlot* pSlot, // executed <Slot-Id>
const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >& rArgs,
SfxCallMode nMode, // Synch/API/...
SfxItemPool& rPool // necessary for the SfxItemSet for parameters
)
: nSlot(pSlot->GetSlotId()),
pArgs(new SfxAllItemSet(rPool)),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = sal_False;
pImp->bIgnored = sal_False;
pImp->SetPool( &rPool );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = sal_False;
TransformParameters( nSlot, rArgs, *pArgs, pSlot );
}
//-----------------------------------------------------------------------
SfxRequest::SfxRequest
(
sal_uInt16 nSlotId,
sal_uInt16 nMode,
const SfxAllItemSet& rSfxArgs
)
// creates a SfxRequest with arguments
: nSlot(nSlotId),
pArgs(new SfxAllItemSet(rSfxArgs)),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = sal_False;
pImp->bIgnored = sal_False;
pImp->SetPool( rSfxArgs.GetPool() );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = sal_False;
}
//--------------------------------------------------------------------
sal_uInt16 SfxRequest::GetCallMode() const
{
return pImp->nCallMode;
}
//--------------------------------------------------------------------
sal_Bool SfxRequest::IsSynchronCall() const
{
return SFX_CALLMODE_SYNCHRON == ( SFX_CALLMODE_SYNCHRON & pImp->nCallMode );
}
//--------------------------------------------------------------------
void SfxRequest::SetSynchronCall( sal_Bool bSynchron )
{
if ( bSynchron )
pImp->nCallMode |= SFX_CALLMODE_SYNCHRON;
else
pImp->nCallMode &= ~(sal_uInt16) SFX_CALLMODE_SYNCHRON;
}
void SfxRequest::SetInternalArgs_Impl( const SfxAllItemSet& rArgs )
{
delete pImp->pInternalArgs;
pImp->pInternalArgs = new SfxAllItemSet( rArgs );
}
const SfxItemSet* SfxRequest::GetInternalArgs_Impl() const
{
return pImp->pInternalArgs;
}
//--------------------------------------------------------------------
void SfxRequest_Impl::Record
(
const uno::Sequence < beans::PropertyValue >& rArgs // current Parameter
)
/* [Description]
Internal helper method to create a <SfxMacroStatement> Instance, which
repeatable describes the just executed SfxRequest. The ownership of thr
created instance, to which a pointer is returned, is handed over to the
caller.
*/
{
String aCommand = String::CreateFromAscii(".uno:");
aCommand.AppendAscii( pSlot->GetUnoName() );
::rtl::OUString aCmd( aCommand );
if(xRecorder.is())
{
uno::Reference< container::XIndexReplace > xReplace( xRecorder, uno::UNO_QUERY );
if ( xReplace.is() && aCmd.compareToAscii(".uno:InsertText") == COMPARE_EQUAL )
{
sal_Int32 nCount = xReplace->getCount();
if ( nCount )
{
frame::DispatchStatement aStatement;
uno::Any aElement = xReplace->getByIndex(nCount-1);
if ( (aElement >>= aStatement) && aStatement.aCommand == aCmd )
{
::rtl::OUString aStr;
::rtl::OUString aNew;
aStatement.aArgs[0].Value >>= aStr;
rArgs[0].Value >>= aNew;
aStr += aNew;
aStatement.aArgs[0].Value <<= aStr;
aElement <<= aStatement;
xReplace->replaceByIndex( nCount-1, aElement );
return;
}
}
}
com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > xFactory(
::comphelper::getProcessServiceFactory(),
com::sun::star::uno::UNO_QUERY);
com::sun::star::uno::Reference< com::sun::star::util::XURLTransformer > xTransform(
xFactory->createInstance(rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("com.sun.star.util.URLTransformer"))),
com::sun::star::uno::UNO_QUERY);
com::sun::star::util::URL aURL;
aURL.Complete = aCmd;
xTransform->parseStrict(aURL);
if (bDone)
xRecorder->recordDispatch(aURL,rArgs);
else
xRecorder->recordDispatchAsComment(aURL,rArgs);
}
}
//--------------------------------------------------------------------
void SfxRequest::Record_Impl
(
SfxShell& rSh, // the <SfxShell>, which has excecuted the Request
const SfxSlot& rSlot, // the <SfxSlot>, which has executed the Request
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > xRecorder,
SfxViewFrame* pViewFrame
)
/* [Description]
This internal method marks the specified SfxMakro SfxRequest as recorded in
SfxMakro. Pointer to the parameters in Done() is used again, thus has to
still be alive.
*/
{
DBG_MEMTEST();
pImp->pShell = &rSh;
pImp->pSlot = &rSlot;
pImp->xRecorder = xRecorder;
pImp->aTarget = rSh.GetName();
pImp->pViewFrame = pViewFrame;
}
//--------------------------------------------------------------------
void SfxRequest::SetArgs( const SfxAllItemSet& rArgs )
{
delete pArgs;
pArgs = new SfxAllItemSet(rArgs);
pImp->SetPool( pArgs->GetPool() );
}
//--------------------------------------------------------------------
void SfxRequest::AppendItem(const SfxPoolItem &rItem)
{
if(!pArgs)
pArgs = new SfxAllItemSet(*pImp->pPool);
pArgs->Put(rItem, rItem.Which());
}
//--------------------------------------------------------------------
void SfxRequest::RemoveItem( sal_uInt16 nID )
{
if (pArgs)
{
pArgs->ClearItem(nID);
if ( !pArgs->Count() )
DELETEZ(pArgs);
}
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetArg
(
sal_uInt16 nSlotId, // Slot-Id or Which-Id of the parameters
bool bDeep, // sal_False: do not seach in the Parent-ItemSets
TypeId aType // != 0: RTTI check with Assertion
) const
{
return GetItem( pArgs, nSlotId, bDeep, aType );
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetItem
(
const SfxItemSet* pArgs,
sal_uInt16 nSlotId, // Slot-Id or Which-Id of the parameters
bool bDeep, // sal_False: do not seach in the Parent-ItemSets
TypeId aType // != 0: RTTI check with Assertion
)
/* [Description]
With this method the access to individual parameters in the SfxRequest is
simplified. In particular the type-examination (by Assertion) is performed,
whereby the application source code will be much clearer. In the product-
version is a 0 returned, if the found item is not of the specified class.
[Example]
void MyShell::Execute( SfxRequest &rReq )
{
switch ( rReq.GetSlot() )
{
case SID_MY:
{
...
// An Example on not using the macros
const SfxInt32Item *pPosItem = (const SfxUInt32Item*)
rReq.GetArg( SID_POS, sal_False, TYPE(SfxInt32Item) );
sal_uInt16 nPos = pPosItem ? pPosItem->GetValue() : 0;
// An Example on using the macros
SFX_REQUEST_ARG(rReq, pSizeItem, SfxInt32Item, SID_SIZE, sal_False);
sal_uInt16 nSize = pSizeItem ? pPosItem->GetValue() : 0;
...
}
...
}
}
*/
{
if ( pArgs )
{
// Which may be converted to ID
sal_uInt16 nWhich = pArgs->GetPool()->GetWhich(nSlotId);
// Is the item set or available at bDeep == sal_True?
const SfxPoolItem *pItem = 0;
if ( ( bDeep ? SFX_ITEM_AVAILABLE : SFX_ITEM_SET )
<= pArgs->GetItemState( nWhich, bDeep, &pItem ) )
{
// Compare type
if ( !pItem || pItem->IsA(aType) )
return pItem;
// Item of wrong type => Programming error
OSL_FAIL( "invalid argument type" );
}
}
// No Parameter, not found or wrong type
return 0;
}
//--------------------------------------------------------------------
void SfxRequest::SetReturnValue(const SfxPoolItem &rItem)
{
DBG_ASSERT(!pImp->pRetVal, "Set Return value multiple times?");
if(pImp->pRetVal)
delete pImp->pRetVal;
pImp->pRetVal = rItem.Clone();
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetReturnValue() const
{
return pImp->pRetVal;
}
//--------------------------------------------------------------------
void SfxRequest::Done
(
const SfxItemSet& rSet, /* parameters passed on by the application,
that for example were asked for by the user
in a dialogue, 0 if no parameters have been
set */
bool bKeep /* true (default)
'rSet' is saved and GetArgs() queriable.
false
'rSet' is not copied (faster) */
)
/* [Description]
This method must be called in the <Execute-Method> of the <SfxSlot>s, which
has performed the SfxRequest when the execution actually took place. If
'Done()' is not called, then the SfxRequest is considered canceled.
Any return values are passed only when 'Done()' was called. Similar, when
recording a macro only true statements are generated if 'Done()' was
called; for SfxRequests that were not identified as such will instead
be commented out by inserting ('rem').
[Note]
'Done ()' is not called, for example when a dialoge started by the function
was canceled by the user or if the execution could not be performed due to
a wrong context (without use of separate <SfxShell>s). 'Done ()' will be
launched, when executing the function led to a regular error
(for example, file could not be opened).
*/
{
Done_Impl( &rSet );
// Keep items if possible, so they can be queried by StarDraw.
if ( bKeep )
{
if ( !pArgs )
{
pArgs = new SfxAllItemSet( rSet );
pImp->SetPool( pArgs->GetPool() );
}
else
{
SfxItemIter aIter(rSet);
const SfxPoolItem* pItem = aIter.FirstItem();
while(pItem)
{
if(!IsInvalidItem(pItem))
pArgs->Put(*pItem,pItem->Which());
pItem = aIter.NextItem();
}
}
}
}
//--------------------------------------------------------------------
void SfxRequest::Done( sal_Bool bRelease )
// [<SfxRequest::Done(SfxItemSet&)>]
{
Done_Impl( pArgs );
if( bRelease )
DELETEZ( pArgs );
}
//--------------------------------------------------------------------
void SfxRequest::ForgetAllArgs()
{
DELETEZ( pArgs );
DELETEZ( pImp->pInternalArgs );
}
//--------------------------------------------------------------------
sal_Bool SfxRequest::IsCancelled() const
{
return pImp->bCancelled;
}
//--------------------------------------------------------------------
void SfxRequest::Cancel()
/* [Description]
Marks this request as no longer executable. For example, if called when
the target (more precisely, its pool) dies.
*/
{
pImp->bCancelled = sal_True;
pImp->SetPool( 0 );
DELETEZ( pArgs );
}
//--------------------------------------------------------------------
void SfxRequest::Ignore()
/* [Description]
If this method is called instead of <SfxRequest::Done()>, then this
request is not recorded.
[Example]
The selecting of tools in StarDraw should not be recorded, but the same
slots are to be used from the generation of the tools to the generated
objects. Thus can NoRecords not be specified, i.e. should not be recorded.
*/
{
// Mark as actually executed
pImp->bIgnored = sal_True;
}
//--------------------------------------------------------------------
void SfxRequest::Done_Impl
(
const SfxItemSet* pSet /* parameters passed on by the application,
that for example were asked for by the user
in a dialogue, 0 if no parameters have been
set */
)
/* [Description]
Internal method to mark SfxRequest with 'done' and to evaluate the
parameters in 'pSet' in case it is recorded.
*/
{
// Mark as actually executed
pImp->bDone = sal_True;
// not Recording
if ( !pImp->xRecorder.is() )
return;
// was running a different slot than requested (Delegation)
if ( nSlot != pImp->pSlot->GetSlotId() )
{
// Search Slot again
pImp->pSlot = pImp->pShell->GetInterface()->GetSlot(nSlot);
DBG_ASSERT( pImp->pSlot, "delegated SlotId not found" );
if ( !pImp->pSlot ) // playing it safe
return;
}
// recordable?
// new Recording uses UnoName!
if ( !pImp->pSlot->pUnoName )
{
rtl::OStringBuffer aStr(RTL_CONSTASCII_STRINGPARAM(
"Recording not exported slot: "));
aStr.append(static_cast<sal_Int32>(pImp->pSlot->GetSlotId()));
OSL_FAIL(aStr.getStr());
}
if ( !pImp->pSlot->pUnoName ) // playing it safe
return;
// often required values
SfxItemPool &rPool = pImp->pShell->GetPool();
// Property-Slot?
if ( !pImp->pSlot->IsMode(SFX_SLOT_METHOD) )
{
// get the property as SfxPoolItem
const SfxPoolItem *pItem;
sal_uInt16 nWhich = rPool.GetWhich(pImp->pSlot->GetSlotId());
SfxItemState eState = pSet ? pSet->GetItemState( nWhich, sal_False, &pItem ) : SFX_ITEM_UNKNOWN;
#ifdef DBG_UTIL
if ( SFX_ITEM_SET != eState )
{
rtl::OStringBuffer aStr(RTL_CONSTASCII_STRINGPARAM(
"Recording property not available: "));
aStr.append(static_cast<sal_Int32>(pImp->pSlot->GetSlotId()));
OSL_FAIL(aStr.getStr());
}
#endif
uno::Sequence < beans::PropertyValue > aSeq;
if ( eState == SFX_ITEM_SET )
TransformItems( pImp->pSlot->GetSlotId(), *pSet, aSeq, pImp->pSlot );
pImp->Record( aSeq );
}
// record everything in a single statement?
else if ( pImp->pSlot->IsMode(SFX_SLOT_RECORDPERSET) )
{
uno::Sequence < beans::PropertyValue > aSeq;
if ( pSet )
TransformItems( pImp->pSlot->GetSlotId(), *pSet, aSeq, pImp->pSlot );
pImp->Record( aSeq );
}
// record each item as a single statement
else if ( pImp->pSlot->IsMode(SFX_SLOT_RECORDPERITEM) )
{
if ( pSet )
{
// iterate over Items
SfxItemIter aIter(*pSet);
for ( const SfxPoolItem* pItem = aIter.FirstItem(); pItem; pItem = aIter.NextItem() )
{
// to determine the slot ID for the individual item
sal_uInt16 nSlotId = rPool.GetSlotId( pItem->Which() );
if ( nSlotId == nSlot )
{
// play it safe; repair the wrong flags
OSL_FAIL( "recursion RecordPerItem - use RecordPerSet!" );
SfxSlot *pSlot = (SfxSlot*) pImp->pSlot;
pSlot->nFlags &= ~((sal_uIntPtr)SFX_SLOT_RECORDPERITEM);
pSlot->nFlags &= SFX_SLOT_RECORDPERSET;
}
// Record a Sub-Request
SfxRequest aReq( pImp->pViewFrame, nSlotId );
if ( aReq.pImp->pSlot )
aReq.AppendItem( *pItem );
aReq.Done();
}
}
else
{
//HACK(think about this again)
pImp->Record( uno::Sequence < beans::PropertyValue >() );
}
}
}
//--------------------------------------------------------------------
sal_Bool SfxRequest::IsDone() const
/* [Description]
With this method it can be queried whether the SfxRequest was actually
executed or not. If a SfxRequest was not executed, then this is for example
because it was canceled by the user or the context for this request was
wrong, this was not implemented on a separate <SfxShell>.
SfxRequest instances that return sal_False will not be recorded.
[Cross-reference]
<SfxRequest::Done(const SfxItemSet&)>
<SfxRequest::Done()>
*/
{
return pImp->bDone;
}
//--------------------------------------------------------------------
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > SfxRequest::GetMacroRecorder( SfxViewFrame* pView )
/* [Description]
This recorder is an attempt for dispatch () to get calls from the Frame.
This is then available through a property by a supplier but only when
recording was turned on.
(See also SfxViewFrame::MiscExec_Impl() and SID_RECORDING)
*/
{
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > xRecorder;
com::sun::star::uno::Reference< com::sun::star::beans::XPropertySet > xSet(
(pView ? pView : SfxViewFrame::Current())->GetFrame().GetFrameInterface(),
com::sun::star::uno::UNO_QUERY);
if(xSet.is())
{
com::sun::star::uno::Any aProp = xSet->getPropertyValue(rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("DispatchRecorderSupplier")));
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorderSupplier > xSupplier;
aProp >>= xSupplier;
if(xSupplier.is())
xRecorder = xSupplier->getDispatchRecorder();
}
return xRecorder;
}
sal_Bool SfxRequest::HasMacroRecorder( SfxViewFrame* pView )
{
return GetMacroRecorder( pView ).is();
}
//--------------------------------------------------------------------
sal_Bool SfxRequest::IsAPI() const
/* [Description]
Returns sal_True if this SfxRequest was generated by an API (for example BASIC),
otherwise sal_False.
*/
{
return SFX_CALLMODE_API == ( SFX_CALLMODE_API & pImp->nCallMode );
}
//--------------------------------------------------------------------
bool SfxRequest::IsRecording() const
/* [Description]
Returns sal_True if this SfxRequest is to be recorded ie
1. Currently a macro is beeing recorded
2. This request is even recorded
3. the request did not originate from a pure API (for example BASIC),
otherwise sal_False.
*/
{
return ( AllowsRecording() && GetMacroRecorder().is() );
}
//--------------------------------------------------------------------
void SfxRequest::SetModifier( sal_uInt16 nModi )
{
pImp->nModifier = nModi;
}
//--------------------------------------------------------------------
sal_uInt16 SfxRequest::GetModifier() const
{
return pImp->nModifier;
}
//--------------------------------------------------------------------
void SfxRequest::SetTarget( const String &rTarget )
/* [Description]
With this method the recording of the target object can be implemented.
[Example]
The BASIC-Methode 'Open' is although executed by the Shell 'Application'
but recorded on the Objekt 'Documents' (global):
rReq.SetTarget( "Documents" );
This then leads to:
Documents.Open( ... )
*/
{
pImp->aTarget = rTarget;
pImp->bUseTarget = sal_True;
}
void SfxRequest::AllowRecording( sal_Bool bSet )
{
pImp->bAllowRecording = bSet;
}
sal_Bool SfxRequest::AllowsRecording() const
{
sal_Bool bAllow = pImp->bAllowRecording;
if( !bAllow )
bAllow = ( SFX_CALLMODE_API != ( SFX_CALLMODE_API & pImp->nCallMode ) ) &&
( SFX_CALLMODE_RECORD == ( SFX_CALLMODE_RECORD & pImp->nCallMode ) );
return bAllow;
}
void SfxRequest::ReleaseArgs()
{
DELETEZ( pArgs );
DELETEZ( pImp->pInternalArgs );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|