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
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: request.cxx,v $
* $Revision: 1.21 $
*
* 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>
#ifndef _ARGS_HXX //autogen
#include <svl/itempool.hxx>
#endif
#include <svtools/itemdel.hxx>
#include <comphelper/processfactory.hxx>
#ifndef GCC
#endif
#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>
//===================================================================
using namespace ::com::sun::star;
struct SfxRequest_Impl: public SfxListener
/* [Beschreibung]
Implementations-Struktur der Klasse <SfxRequest>.
*/
{
SfxRequest* pAnti; // Owner wegen sterbendem Pool
String aTarget; // ggf. von App gesetztes Zielobjekt
SfxItemPool* pPool; // ItemSet mit diesem Pool bauen
SfxPoolItem* pRetVal; // R"uckgabewert geh"ort sich selbst
SfxShell* pShell; // ausgef"uhrt an dieser Shell
const SfxSlot* pSlot; // ausgef"uhrter Slot
USHORT nModifier; // welche Modifier waren gedrueckt?
BOOL bDone; // "uberhaupt ausgef"uhrt
BOOL bIgnored; // vom User abgebrochen
BOOL bCancelled; // nicht mehr zustellen
BOOL bUseTarget; // aTarget wurde von Applikation gesetzt
USHORT nCallMode; // Synch/Asynch/API/Record
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(FALSE)
, nCallMode( SFX_CALLMODE_SYNCHRON )
, bAllowRecording( 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();
// nicht mit Done() marktierte Requests mit 'rem' rausschreiben
if ( pImp->xRecorder.is() && !pImp->bDone && !pImp->bIgnored )
pImp->Record( uno::Sequence < beans::PropertyValue >() );
// Objekt abr"aumen
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 = FALSE;
pImp->bIgnored = 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,
USHORT nSlotId
)
/* [Beschreibung]
Mit diesem Konstruktor k"onnen Events, die nicht "uber den SfxDispatcher
gelaufen sind (z.B aus KeyInput() oder Mouse-Events) nachtr"aglich
recorded werden. Dazu wird eine SfxRequest-Instanz mit diesem Konstruktor
erzeugt und dann genauso verfahren, wie mit einem SfxRequest, der in
eine <Slot-Execute-Methode> als Parameter gegeben wird.
*/
: nSlot(nSlotId),
pArgs(0),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = FALSE;
pImp->bIgnored = FALSE;
pImp->SetPool( &pViewFrame->GetPool() );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = SFX_CALLMODE_SYNCHRON;
pImp->bUseTarget = FALSE;
pImp->pViewFrame = pViewFrame;
if( pImp->pViewFrame->GetDispatcher()->GetShellAndSlot_Impl( nSlotId, &pImp->pShell, &pImp->pSlot, TRUE, TRUE ) )
{
pImp->SetPool( &pImp->pShell->GetPool() );
pImp->xRecorder = SfxRequest::GetMacroRecorder( pViewFrame );
pImp->aTarget = pImp->pShell->GetName();
}
#ifdef DBG_UTIL
else
{
ByteString aStr( "Recording unsupported slot: ");
aStr += ByteString::CreateFromInt32( pImp->pPool->GetSlotId(nSlotId) );
DBG_ERROR( aStr.GetBuffer() );
}
#endif
}
//--------------------------------------------------------------------
SfxRequest::SfxRequest
(
USHORT nSlotId, // auszuf"uhrende <Slot-Id>
SfxCallMode nMode, // Synch/API/...
SfxItemPool& rPool // ggf. f"ur das SfxItemSet f"ur Parameter
)
// creates a SfxRequest without arguments
: nSlot(nSlotId),
pArgs(0),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = FALSE;
pImp->bIgnored = FALSE;
pImp->SetPool( &rPool );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = FALSE;
}
SfxRequest::SfxRequest
(
const SfxSlot* pSlot, // auszuf"uhrende <Slot-Id>
const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >& rArgs,
SfxCallMode nMode, // Synch/API/...
SfxItemPool& rPool // ggf. f"ur das SfxItemSet f"ur Parameter
)
: nSlot(pSlot->GetSlotId()),
pArgs(new SfxAllItemSet(rPool)),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = FALSE;
pImp->bIgnored = FALSE;
pImp->SetPool( &rPool );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = FALSE;
TransformParameters( nSlot, rArgs, *pArgs, pSlot );
}
//-----------------------------------------------------------------------
SfxRequest::SfxRequest
(
USHORT nSlotId,
USHORT nMode,
const SfxAllItemSet& rSfxArgs
)
// creates a SfxRequest with arguments
: nSlot(nSlotId),
pArgs(new SfxAllItemSet(rSfxArgs)),
pImp( new SfxRequest_Impl(this) )
{
DBG_MEMTEST();
pImp->bDone = FALSE;
pImp->bIgnored = FALSE;
pImp->SetPool( rSfxArgs.GetPool() );
pImp->pRetVal = 0;
pImp->pShell = 0;
pImp->pSlot = 0;
pImp->nCallMode = nMode;
pImp->bUseTarget = FALSE;
}
//--------------------------------------------------------------------
USHORT SfxRequest::GetCallMode() const
{
return pImp->nCallMode;
}
//--------------------------------------------------------------------
BOOL SfxRequest::IsSynchronCall() const
{
return SFX_CALLMODE_SYNCHRON == ( SFX_CALLMODE_SYNCHRON & pImp->nCallMode );
}
//--------------------------------------------------------------------
void SfxRequest::SetSynchronCall( BOOL bSynchron )
{
if ( bSynchron )
pImp->nCallMode |= SFX_CALLMODE_SYNCHRON;
else
pImp->nCallMode &= ~(USHORT) 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 // aktuelle Parameter
)
/* [Beschreibung]
Interne Hilfsmethode zum erzeugen einer <SfxMacroStatement>-Instanz,
welche den bereits ausgef"uhrten SfxRequest wiederholbar beschreibt.
Die erzeugte Instanz, auf die ein Pointer zur"uckgeliefert wird
geht in das Eigentum des Aufrufers "uber.
*/
{
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::createFromAscii("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, // die <SfxShell>, die den Request ausgef"uhrt hat
const SfxSlot& rSlot, // der <SfxSlot>, der den Request ausgef"uhrt hat
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > xRecorder, // der Recorder, mit dem aufgezeichnet wird
SfxViewFrame* pViewFrame
)
/* [Beschreibung]
Diese interne Methode markiert den SfxRequest als in dem angegebenen
SfxMakro aufzuzeichnen.
Pointer auf die Parameter werden in Done() wieder verwendet, m"usseb
dann also noch leben.
*/
{
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( USHORT nID )
{
if (pArgs)
{
pArgs->ClearItem(nID);
if ( !pArgs->Count() )
DELETEZ(pArgs);
}
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetArg
(
USHORT nSlotId, // Slot-Id oder Which-Id des Parameters
FASTBOOL bDeep, // FALSE: nicht in Parent-ItemSets suchen
TypeId aType // != 0: RTTI Pruefung mit Assertion
) const
{
return GetItem( pArgs, nSlotId, bDeep, aType );
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetItem
(
const SfxItemSet* pArgs,
USHORT nSlotId, // Slot-Id oder Which-Id des Parameters
bool bDeep, // false: nicht in Parent-ItemSets suchen
TypeId aType // != 0: RTTI Pruefung mit Assertion
)
/* [Beschreibung]
Mit dieser Methode wird der Zugriff auf einzelne Parameter im
SfxRequest wesentlich vereinfacht. Insbesondere wird die Typpr"ufung
(per Assertion) durchgef"uhrt, wodurch die Applikations-Sourcen
wesentlich "ubersichtlicher werden. In der PRODUCT-Version wird
eine 0 zur"uckgegeben, wenn das gefundene Item nicht von der
angegebenen Klasse ist.
[Beispiel]
void MyShell::Execute( SfxRequest &rReq )
{
switch ( rReq.GetSlot() )
{
case SID_MY:
{
...
// ein Beispiel ohne Verwendung des Makros
const SfxInt32Item *pPosItem = (const SfxUInt32Item*)
rReq.GetArg( SID_POS, FALSE, TYPE(SfxInt32Item) );
USHORT nPos = pPosItem ? pPosItem->GetValue() : 0;
// ein Beispiel mit Verwendung des Makros
SFX_REQUEST_ARG(rReq, pSizeItem, SfxInt32Item, SID_SIZE, FALSE);
USHORT nSize = pSizeItem ? pPosItem->GetValue() : 0;
...
}
...
}
}
*/
{
if ( pArgs )
{
// ggf. in Which-Id umrechnen
USHORT nWhich = pArgs->GetPool()->GetWhich(nSlotId);
// ist das Item gesetzt oder bei bDeep==TRUE verf"ugbar?
const SfxPoolItem *pItem = 0;
if ( ( bDeep ? SFX_ITEM_AVAILABLE : SFX_ITEM_SET )
<= pArgs->GetItemState( nWhich, bDeep, &pItem ) )
{
// stimmt der Typ "uberein?
if ( !pItem || pItem->IsA(aType) )
return pItem;
// Item da aber falsch => Programmierfehler
DBG_ERROR( "invalid argument type" );
}
}
// keine Parameter, nicht gefunden oder falschen Typ gefunden
return 0;
}
//--------------------------------------------------------------------
void SfxRequest::SetReturnValue(const SfxPoolItem &rItem)
{
DBG_ASSERT(!pImp->pRetVal, "Returnwert mehrfach setzen?");
if(pImp->pRetVal)
delete pImp->pRetVal;
pImp->pRetVal = rItem.Clone();
}
//--------------------------------------------------------------------
const SfxPoolItem* SfxRequest::GetReturnValue() const
{
return pImp->pRetVal;
}
//--------------------------------------------------------------------
void SfxRequest::Done
(
const SfxItemSet& rSet, /* von der Applikation mitgeteilte Parameter,
die z.B. in einem Dialog vom Benuter
erfragt wurden, ggf. 0 falls keine
Parameter gesetzt wurden */
FASTBOOL bKeep /* TRUE (default)
'rSet' wird gepeichert und ist "uber
GetArgs() abfragbar
FALSE
'rSet' wird nicht kopiert (schneller) */
)
/* [Beschreibung]
Diese Methode mu\s in der <Execute-Methode> des <SfxSlot>s gerufen
werden, der den SfxRequest ausgef"uhrt hat, wenn die Ausf"uhrung
tats"achlich stattgefunden hat. Wird 'Done()' nicht gerufen, gilt
der SfxRequest als abgebrochen.
Etwaige Returnwerte werden nur durchgereicht, wenn 'Done()' gerufen
wurde. Ebenso werden beim Aufzeichnen von Makros nur echte
Statements erzeugt, wenn 'Done()' gerufen wurde; f"ur SfxRequests,
die nicht derart gekennzeichnet wurden, wird anstelle dessen eine
auf die abgebrochene Funktion hinweisende Bemerkung ('rem') eingf"ugt.
[Anmerkung]
'Done()' wird z.B. nicht gerufen, wenn ein durch die Funktion gestarteter
Dialog vom Benutzer abgebrochen wurde oder das Ausf"uhren aufgrund
eines falschen Kontextes (ohne Verwendung separater <SfxShell>s)
nicht durchgef"uhrt werden konnte. 'Done()' mu\s sehr wohl gerufen
werden, wenn das Ausf"uhren der Funktion zu einem regul"aren Fehler
f"uhrte (z.B. Datei konnte nicht ge"offnet werden).
*/
{
Done_Impl( &rSet );
// ggf. Items merken, damit StarDraw sie abfragen kann
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( BOOL bRelease )
// [<SfxRequest::Done(SfxItemSet&)>]
{
Done_Impl( pArgs );
if( bRelease )
DELETEZ( pArgs );
}
//--------------------------------------------------------------------
void SfxRequest::ForgetAllArgs()
{
DELETEZ( pArgs );
DELETEZ( pImp->pInternalArgs );
}
//--------------------------------------------------------------------
BOOL SfxRequest::IsCancelled() const
{
return pImp->bCancelled;
}
//--------------------------------------------------------------------
void SfxRequest::Cancel()
/* [Beschreibung]
Markiert diesen Request als nicht mehr auszufuehren. Wird z.B. gerufen,
wenn das Ziel (genauer dessen Pool) stirbt.
*/
{
pImp->bCancelled = TRUE;
pImp->SetPool( 0 );
DELETEZ( pArgs );
}
//--------------------------------------------------------------------
void SfxRequest::Ignore()
/* [Beschreibung]
Wird diese Methode anstelle von <SfxRequest::Done()> gerufen, dann
wird dieser Request nicht recorded.
[Bespiel]
Das Selektieren von Tools im StarDraw soll nicht aufgezeichnet werden,
dieselben Slots sollen aber zum erzeugen der von den Tools zu
erzeugenden Objekte verwendet werde. Also kann nicht NoRecord
angegeben werden, dennoch soll u.U. nicht aufgezeichnet werden.
*/
{
// als tats"achlich ausgef"uhrt markieren
pImp->bIgnored = TRUE;
}
//--------------------------------------------------------------------
void SfxRequest::Done_Impl
(
const SfxItemSet* pSet /* von der Applikation mitgeteilte Parameter,
die z.B. in einem Dialog vom Benuter
erfragt wurden, ggf. 0 falls keine
Parameter gesetzt wurden */
)
/* [Beschreibung]
Interne Methode zum als 'done' markieren des SfxRequest und zum Auswerten
der Parameter in 'pSet' falls aufgezeichnet wird.
*/
{
// als tats"achlich ausgef"uhrt markieren
pImp->bDone = TRUE;
// nicht Recorden
if ( !pImp->xRecorder.is() )
return;
// wurde ein anderer Slot ausgef"uhrt als angefordert (Delegation)
if ( nSlot != pImp->pSlot->GetSlotId() )
{
// Slot neu suchen
pImp->pSlot = pImp->pShell->GetInterface()->GetSlot(nSlot);
DBG_ASSERT( pImp->pSlot, "delegated SlotId not found" );
if ( !pImp->pSlot ) // Hosentr"ger und G"urtel
return;
}
// record-f"ahig?
// neues Recorden verwendet UnoName!
if ( !pImp->pSlot->pUnoName )
{
ByteString aStr( "Recording not exported slot: ");
aStr += ByteString::CreateFromInt32( pImp->pSlot->GetSlotId() );
DBG_ERROR( aStr.GetBuffer() );
}
if ( !pImp->pSlot->pUnoName ) // Hosentr"ger und G"urtel
return;
// "ofters ben"otigte Werte
SfxItemPool &rPool = pImp->pShell->GetPool();
// Property-Slot?
if ( !pImp->pSlot->IsMode(SFX_SLOT_METHOD) )
{
// des Property als SfxPoolItem besorgen
const SfxPoolItem *pItem;
USHORT nWhich = rPool.GetWhich(pImp->pSlot->GetSlotId());
SfxItemState eState = pSet ? pSet->GetItemState( nWhich, FALSE, &pItem ) : SFX_ITEM_UNKNOWN;
#ifdef DBG_UTIL
if ( SFX_ITEM_SET != eState )
{
ByteString aStr( "Recording property not available: ");
aStr += ByteString::CreateFromInt32( pImp->pSlot->GetSlotId() );
DBG_ERROR( aStr.GetBuffer() );
}
#endif
uno::Sequence < beans::PropertyValue > aSeq;
if ( eState == SFX_ITEM_SET )
TransformItems( pImp->pSlot->GetSlotId(), *pSet, aSeq, pImp->pSlot );
pImp->Record( aSeq );
}
// alles in ein einziges Statement aufzeichnen?
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 );
}
// jedes Item als einzelnes Statement recorden
else if ( pImp->pSlot->IsMode(SFX_SLOT_RECORDPERITEM) )
{
if ( pSet )
{
// "uber die Items iterieren
SfxItemIter aIter(*pSet);
for ( const SfxPoolItem* pItem = aIter.FirstItem(); pItem; pItem = aIter.NextItem() )
{
// die Slot-Id f"ur das einzelne Item ermitteln
USHORT nSlotId = rPool.GetSlotId( pItem->Which() );
if ( nSlotId == nSlot )
{
// mit Hosentr"ager und G"urtel reparieren des falschen Flags
DBG_ERROR( "recursion RecordPerItem - use RecordPerSet!" );
SfxSlot *pSlot = (SfxSlot*) pImp->pSlot;
pSlot->nFlags &= ~((ULONG)SFX_SLOT_RECORDPERITEM);
pSlot->nFlags &= SFX_SLOT_RECORDPERSET;
}
// einen Sub-Request recorden
SfxRequest aReq( pImp->pViewFrame, nSlotId );
if ( aReq.pImp->pSlot )
aReq.AppendItem( *pItem );
aReq.Done();
}
}
else
{
HACK(hierueber nochmal nachdenken)
pImp->Record( uno::Sequence < beans::PropertyValue >() );
}
}
}
//--------------------------------------------------------------------
BOOL SfxRequest::IsDone() const
/* [Beschreibung]
Mit dieser Methode kann abgefragt werden, ob der SfxRequest tats"achlich
ausgef"uhrt wurde oder nicht. Wurde ein SfxRequest nicht ausgef"uhrt,
liegt dies z.B. daran, da\s der Benutzer abgebrochen hat oder
der Kontext f"ur diesen Request falsch war, dieses aber nicht "uber
eine separate <SfxShell> realisiert wurde.
SfxRequest-Instanzen, die hier FALSE liefern, werden nicht recorded.
[Querverweise]
<SfxRequest::Done(const SfxItemSet&)>
<SfxRequest::Done()>
*/
{
return pImp->bDone;
}
//--------------------------------------------------------------------
SfxMacro* SfxRequest::GetRecordingMacro()
/* [Beschreibung]
Mit dieser Methode kann abgefragt werden, ob und in welchem <SfxMacro>
die SfxRequests gerade aufgezeichnet werden.
*/
{
return NULL;
}
//--------------------------------------------------------------------
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > SfxRequest::GetMacroRecorder( SfxViewFrame* pView )
/* [Beschreibung]
Hier wird versucht einen Recorder fuer dispatch() Aufrufe vom Frame zu bekommen.
Dieser ist dort per Property an einem Supplier verfuegbar - aber nur dann, wenn
recording angeschaltet wurde.
(Siehe auch SfxViewFrame::MiscExec_Impl() und 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::createFromAscii("DispatchRecorderSupplier"));
com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorderSupplier > xSupplier;
aProp >>= xSupplier;
if(xSupplier.is())
xRecorder = xSupplier->getDispatchRecorder();
}
return xRecorder;
}
BOOL SfxRequest::HasMacroRecorder( SfxViewFrame* pView )
{
return GetMacroRecorder( pView ).is();
}
//--------------------------------------------------------------------
BOOL SfxRequest::IsAPI() const
/* [Beschreibung]
Liefert TRUE, wenn dieser SfxRequest von einer API (z.B. BASIC)
erzeugt wurde, sonst FALSE.
*/
{
return SFX_CALLMODE_API == ( SFX_CALLMODE_API & pImp->nCallMode );
}
//--------------------------------------------------------------------
FASTBOOL SfxRequest::IsRecording() const
/* [Beschreibung]
Liefert TRUE, wenn dieser SfxRequest recorded werden soll, d.h.
1. zu Zeit ein Makro aufgezeichnet wird
2. dieser Request "uberhaupt aufgezeichnet wird
3. der Request nicht von reiner API (z.B. BASIC) ausgeht,
sonst FALSE.
*/
{
return ( AllowsRecording() && GetMacroRecorder().is() );
}
//--------------------------------------------------------------------
void SfxRequest::SetModifier( USHORT nModi )
{
pImp->nModifier = nModi;
}
//--------------------------------------------------------------------
USHORT SfxRequest::GetModifier() const
{
return pImp->nModifier;
}
//--------------------------------------------------------------------
void SfxRequest::SetTarget( const String &rTarget )
/* [Beschreibung]
Mit dieser Methode kann das zu recordende Zielobjekt umgesetzt werden.
[Beispiel]
Die BASIC-Methode 'Open' wird zwar von der Shell 'Application' ausgef"uhrt,
aber am Objekt 'Documents' (global) recorded:
rReq.SetTarget( "Documents" );
Dies f"uhrt dann zu:
Documents.Open( ... )
*/
{
pImp->aTarget = rTarget;
pImp->bUseTarget = TRUE;
}
void SfxRequest::AllowRecording( BOOL bSet )
{
pImp->bAllowRecording = bSet;
}
BOOL SfxRequest::AllowsRecording() const
{
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 );
}
|