?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
merge the formfield patch from ooo-build
[ooovba.git] / svtools / source / config / dynamicmenuoptions.cxx
blob0deaab5cfe9ee78629c476c4e28d17fbc4dd8aac
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: dynamicmenuoptions.cxx,v $
10 * $Revision: 1.18 $
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_svtools.hxx"
33 #ifndef GCC
34 #endif
35
36 //_________________________________________________________________________________________________________________
37 // includes
38 //_________________________________________________________________________________________________________________
39
40 #include <svtools/dynamicmenuoptions.hxx>
41 #include <svtools/moduleoptions.hxx>
42 #include <unotools/configmgr.hxx>
43 #include <unotools/configitem.hxx>
44 #include <tools/debug.hxx>
45 #include <com/sun/star/uno/Any.hxx>
46 #include <com/sun/star/uno/Sequence.hxx>
47
48 #ifndef __SGI_STL_VECTOR
49 #include <vector>
50 #endif
51
52 #include <itemholder1.hxx>
53
54 #include <algorithm>
55
56 //_________________________________________________________________________________________________________________
57 // namespaces
58 //_________________________________________________________________________________________________________________
59
60 using namespace ::std ;
61 using namespace ::utl ;
62 using namespace ::rtl ;
63 using namespace ::osl ;
64 using namespace ::com::sun::star::uno ;
65 using namespace ::com::sun::star::beans ;
66
67 //_________________________________________________________________________________________________________________
68 // const
69 //_________________________________________________________________________________________________________________
70
71 #define ROOTNODE_MENUS OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/Menus/" ))
72 #define PATHDELIMITER OUString(RTL_CONSTASCII_USTRINGPARAM("/" ))
73
74 #define SETNODE_NEWMENU OUString(RTL_CONSTASCII_USTRINGPARAM("New" ))
75 #define SETNODE_WIZARDMENU OUString(RTL_CONSTASCII_USTRINGPARAM("Wizard" ))
76 #define SETNODE_HELPBOOKMARKS OUString(RTL_CONSTASCII_USTRINGPARAM("HelpBookmarks" ))
77
78 #define PROPERTYNAME_URL DYNAMICMENU_PROPERTYNAME_URL
79 #define PROPERTYNAME_TITLE DYNAMICMENU_PROPERTYNAME_TITLE
80 #define PROPERTYNAME_IMAGEIDENTIFIER DYNAMICMENU_PROPERTYNAME_IMAGEIDENTIFIER
81 #define PROPERTYNAME_TARGETNAME DYNAMICMENU_PROPERTYNAME_TARGETNAME
82
83 #define PROPERTYCOUNT 4
84
85 #define OFFSET_URL 0
86 #define OFFSET_TITLE 1
87 #define OFFSET_IMAGEIDENTIFIER 2
88 #define OFFSET_TARGETNAME 3
89
90 #define PATHPREFIX_SETUP OUString(RTL_CONSTASCII_USTRINGPARAM("m" ))
91 #define PATHPREFIX_USER OUString(RTL_CONSTASCII_USTRINGPARAM("u" ))
92
93 //_________________________________________________________________________________________________________________
94 // private declarations!
95 //_________________________________________________________________________________________________________________
96
97 /*-****************************************************************************************************************
98 @descr struct to hold information about one menu entry.
99 ****************************************************************************************************************-*/
100 struct SvtDynMenuEntry
101 {
102 public:
103 SvtDynMenuEntry() {};
104
105 SvtDynMenuEntry( const OUString& sNewURL ,
106 const OUString& sNewTitle ,
107 const OUString& sNewImageIdentifier ,
108 const OUString& sNewTargetName )
109 {
110 sURL = sNewURL ;
111 sTitle = sNewTitle ;
112 sImageIdentifier = sNewImageIdentifier ;
113 sTargetName = sNewTargetName ;
114 }
115
116 public:
117 OUString sName ;
118 OUString sURL ;
119 OUString sTitle ;
120 OUString sImageIdentifier ;
121 OUString sTargetName ;
122 };
123
124 /*-****************************************************************************************************************
125 @descr support simple menu structures and operations on it
126 ****************************************************************************************************************-*/
127 class SvtDynMenu
128 {
129 public:
130 //---------------------------------------------------------------------------------------------------------
131 // append setup written menu entry
132 // Don't touch name of entry. It was defined by setup and must be the same everytime!
133 // Look for double menu entries here too ... may be some seperator items are supeflous ...
134 void AppendSetupEntry( const SvtDynMenuEntry& rEntry )
135 {
136 if(
137 ( lSetupEntries.size() < 1 ) ||
138 ( lSetupEntries.rbegin()->sURL != rEntry.sURL )
139 )
140 {
141 lSetupEntries.push_back( rEntry );
142 }
143 }
144
145 //---------------------------------------------------------------------------------------------------------
146 // append user specific menu entry
147 // We must find unique name for it by using special prefix
148 // and next count of user setted entries!
149 // Look for double menu entries here too ... may be some seperator items are supeflous ...
150 void AppendUserEntry( SvtDynMenuEntry& rEntry )
151 {
152 if(
153 ( lUserEntries.size() < 1 ) ||
154 ( lUserEntries.rbegin()->sURL != rEntry.sURL )
155 )
156 {
157 rEntry.sName = PATHPREFIX_USER;
158 rEntry.sName += OUString::valueOf( (sal_Int32)impl_getNextUserEntryNr() );
159 lUserEntries.push_back( rEntry );
160 }
161 }
162
163 //---------------------------------------------------------------------------------------------------------
164 // the only way to free memory!
165 void Clear()
166 {
167 lSetupEntries.clear();
168 lUserEntries.clear();
169 }
170
171 //---------------------------------------------------------------------------------------------------------
172 // convert internal list to external format
173 // for using it on right menus realy
174 // Notice: We build a property list with 4 entries and set it on result list then.
175 // The while-loop starts with pointer on internal member list lSetupEntries, change to
176 // lUserEntries then and stop after that with NULL!
177 // Separator entries will be packed in another way then normal entries! We define
178 // special strings "sEmpty" and "sSeperator" to perform too ...
179 Sequence< Sequence< PropertyValue > > GetList() const
180 {
181 sal_Int32 nSetupCount = (sal_Int32)lSetupEntries.size();
182 sal_Int32 nUserCount = (sal_Int32)lUserEntries.size();
183 sal_Int32 nStep = 0;
184 Sequence< PropertyValue > lProperties ( PROPERTYCOUNT );
185 Sequence< Sequence< PropertyValue > > lResult ( nSetupCount+nUserCount );
186 OUString sSeperator ( RTL_CONSTASCII_USTRINGPARAM("private:separator") );
187 OUString sEmpty ;
188 const vector< SvtDynMenuEntry >* pList = &lSetupEntries;
189
190 lProperties[OFFSET_URL ].Name = PROPERTYNAME_URL ;
191 lProperties[OFFSET_TITLE ].Name = PROPERTYNAME_TITLE ;
192 lProperties[OFFSET_IMAGEIDENTIFIER].Name = PROPERTYNAME_IMAGEIDENTIFIER ;
193 lProperties[OFFSET_TARGETNAME ].Name = PROPERTYNAME_TARGETNAME ;
194
195 while( pList != NULL )
196 {
197 for( vector< SvtDynMenuEntry >::const_iterator pItem =pList->begin();
198 pItem!=pList->end() ;
199 ++pItem )
200 {
201 if( pItem->sURL == sSeperator )
202 {
203 lProperties[OFFSET_URL ].Value <<= sSeperator ;
204 lProperties[OFFSET_TITLE ].Value <<= sEmpty ;
205 lProperties[OFFSET_IMAGEIDENTIFIER ].Value <<= sEmpty ;
206 lProperties[OFFSET_TARGETNAME ].Value <<= sEmpty ;
207 }
208 else
209 {
210 lProperties[OFFSET_URL ].Value <<= pItem->sURL ;
211 lProperties[OFFSET_TITLE ].Value <<= pItem->sTitle ;
212 lProperties[OFFSET_IMAGEIDENTIFIER ].Value <<= pItem->sImageIdentifier;
213 lProperties[OFFSET_TARGETNAME ].Value <<= pItem->sTargetName ;
214 }
215 lResult[nStep] = lProperties;
216 ++nStep;
217 }
218 if( pList == &lSetupEntries )
219 pList = &lUserEntries;
220 else
221 pList = NULL;
222 }
223 return lResult;
224 }
225
226 private:
227 //---------------------------------------------------------------------------------------------------------
228 // search for an entry named "ux" with x=[0..i] inside our menu
229 // which has set highest number x. So we can add another user entry.
230 sal_Int32 impl_getNextUserEntryNr() const
231 {
232 sal_Int32 nNr = 0;
233 for( vector< SvtDynMenuEntry >::const_iterator pItem =lUserEntries.begin();
234 pItem!=lUserEntries.end() ;
235 ++pItem )
236 {
237 if( pItem->sName.compareTo( PATHPREFIX_USER, 1 ) == 0 )
238 {
239 OUString sNr = pItem->sName.copy( 1, pItem->sName.getLength()-1 );
240 sal_Int32 nCheckNr = sNr.toInt32();
241 if( nCheckNr > nNr )
242 nNr = nCheckNr;
243 }
244 }
245 // Attention: Code isn't prepared for recyling of unused fragmented numbers!
246 // If we reach end of sal_Int32 range ... we must stop further working ...
247 // But I think nobody expand a menu to more then 1000 ... 100000 ... entries ... or?
248 DBG_ASSERT( !(nNr>0x7fffffff), "Menu::impl_getNextUserEntryNr()\nUser count can be out of range next time ...\n" );
249 return nNr;
250 }
251
252 private:
253 vector< SvtDynMenuEntry > lSetupEntries;
254 vector< SvtDynMenuEntry > lUserEntries ;
255 };
256
257 class SvtDynamicMenuOptions_Impl : public ConfigItem
258 {
259 //-------------------------------------------------------------------------------------------------------------
260 // public methods
261 //-------------------------------------------------------------------------------------------------------------
262
263 public:
264
265 //---------------------------------------------------------------------------------------------------------
266 // constructor / destructor
267 //---------------------------------------------------------------------------------------------------------
268
269 SvtDynamicMenuOptions_Impl();
270 ~SvtDynamicMenuOptions_Impl();
271
272 //---------------------------------------------------------------------------------------------------------
273 // overloaded methods of baseclass
274 //---------------------------------------------------------------------------------------------------------
275
276 /*-****************************************************************************************************//**
277 @short called for notify of configmanager
278 @descr These method is called from the ConfigManager before application ends or from the
279 PropertyChangeListener if the sub tree broadcasts changes. You must update your
280 internal values.
281
282 @seealso baseclass ConfigItem
283
284 @param "lPropertyNames" is the list of properties which should be updated.
285 @return -
286
287 @onerror -
288 *//*-*****************************************************************************************************/
289
290 virtual void Notify( const Sequence< OUString >& lPropertyNames );
291
292 /*-****************************************************************************************************//**
293 @short write changes to configuration
294 @descr These method writes the changed values into the sub tree
295 and should always called in our destructor to guarantee consistency of config data.
296
297 @seealso baseclass ConfigItem
298
299 @param -
300 @return -
301
302 @onerror -
303 *//*-*****************************************************************************************************/
304
305 virtual void Commit();
306
307 //---------------------------------------------------------------------------------------------------------
308 // public interface
309 //---------------------------------------------------------------------------------------------------------
310
311 /*-****************************************************************************************************//**
312 @short base implementation of public interface for "SvtDynamicMenuOptions"!
313 @descr These class is used as static member of "SvtDynamicMenuOptions" ...
314 => The code exist only for one time and isn't duplicated for every instance!
315
316 @seealso -
317
318 @param -
319 @return -
320
321 @onerror -
322 *//*-*****************************************************************************************************/
323
324 void Clear ( EDynamicMenuType eMenu );
325 Sequence< Sequence< PropertyValue > > GetMenu ( EDynamicMenuType eMenu ) const ;
326 void AppendItem ( EDynamicMenuType eMenu ,
327 const OUString& sURL ,
328 const OUString& sTitle ,
329 const OUString& sImageIdentifier,
330 const OUString& sTargetName );
331
332 //-------------------------------------------------------------------------------------------------------------
333 // private methods
334 //-------------------------------------------------------------------------------------------------------------
335
336 private:
337
338 /*-****************************************************************************************************//**
339 @short return list of key names of our configuration management which represent oue module tree
340 @descr These methods return the current list of key names! We need it to get needed values from our
341 configuration management and support dynamical menu item lists!
342
343 @seealso -
344
345 @param "nNewCount" , returns count of menu entries for "new"
346 @param "nWizardCount" , returns count of menu entries for "wizard"
347 @return A list of configuration key names is returned.
348
349 @onerror -
350 *//*-*****************************************************************************************************/
351
352 Sequence< OUString > impl_GetPropertyNames( sal_uInt32& nNewCount, sal_uInt32& nWizardCount, sal_uInt32& nHelpBookmarksCount );
353
354 /*-****************************************************************************************************//**
355 @short sort given source list and expand it for all well known properties to destination
356 @descr We must support sets of entries with count inside the name .. but some of them could be missing!
357 e.g. s1-s2-s3-s0-u1-s6-u5-u7
358 Then we must sort it by name and expand it to the follow one:
359 sSetNode/s0/URL
360 sSetNode/s0/Title
361 sSetNode/s0/...
362 sSetNode/s1/URL
363 sSetNode/s1/Title
364 sSetNode/s1/...
365 ...
366 sSetNode/s6/URL
367 sSetNode/s6/Title
368 sSetNode/s6/...
369 sSetNode/u1/URL
370 sSetNode/u1/Title
371 sSetNode/u1/...
372 ...
373 sSetNode/u7/URL
374 sSetNode/u7/Title
375 sSetNode/u7/...
376 Rules: We start with all setup written entries names "sx" and x=[0..n].
377 Then we handle all "ux" items. Inside these blocks we sort it ascending by number.
378
379 @attention We add these expanded list to the end of given "lDestination" list!
380 So we must start on "lDestination.getLength()".
381 Reallocation of memory of destination list is done by us!
382
383 @seealso method impl_GetPropertyNames()
384
385 @param "lSource" , original list (e.g. [m1-m2-m3-m6-m0] )
386 @param "lDestination" , destination of operation
387 @param "sSetNode" , name of configuration set to build complete path
388 @return A list of configuration key names is returned.
389
390 @onerror -
391 *//*-*****************************************************************************************************/
392
393 void impl_SortAndExpandPropertyNames( const Sequence< OUString >& lSource ,
394 Sequence< OUString >& lDestination ,
395 const OUString& sSetNode );
396
397 //-------------------------------------------------------------------------------------------------------------
398 // private member
399 //-------------------------------------------------------------------------------------------------------------
400
401 private:
402
403 SvtDynMenu m_aNewMenu ;
404 SvtDynMenu m_aWizardMenu ;
405 SvtDynMenu m_aHelpBookmarksMenu ;
406 };
407
408 //_________________________________________________________________________________________________________________
409 // definitions
410 //_________________________________________________________________________________________________________________
411
412 //*****************************************************************************************************************
413 // constructor
414 //*****************************************************************************************************************
415 SvtDynamicMenuOptions_Impl::SvtDynamicMenuOptions_Impl()
416 // Init baseclasses first
417 : ConfigItem( ROOTNODE_MENUS )
418 // Init member then...
419 {
420 // Get names and values of all accessable menu entries and fill internal structures.
421 // See impl_GetPropertyNames() for further informations.
422 sal_uInt32 nNewCount = 0;
423 sal_uInt32 nWizardCount = 0;
424 sal_uInt32 nHelpBookmarksCount = 0;
425 Sequence< OUString > lNames = impl_GetPropertyNames ( nNewCount ,
426 nWizardCount ,
427 nHelpBookmarksCount );
428 Sequence< Any > lValues = GetProperties ( lNames );
429
430 // Safe impossible cases.
431 // We need values from ALL configuration keys.
432 // Follow assignment use order of values in relation to our list of key names!
433 DBG_ASSERT( !(lNames.getLength()!=lValues.getLength()), "SvtDynamicMenuOptions_Impl::SvtDynamicMenuOptions_Impl()\nI miss some values of configuration keys!\n" );
434
435 // Copy values from list in right order to ouer internal member.
436 // Attention: List for names and values have an internal construction pattern!
437 //
438 // first "New" menu ...
439 // Name Value
440 // /New/1/URL "private:factory/swriter"
441 // /New/1/Title "Neues Writer Dokument"
442 // /New/1/ImageIdentifier "icon_writer"
443 // /New/1/TargetName "_blank"
444 //
445 // /New/2/URL "private:factory/scalc"
446 // /New/2/Title "Neues Calc Dokument"
447 // /New/2/ImageIdentifier "icon_calc"
448 // /New/2/TargetName "_blank"
449 //
450 // second "Wizard" menu ...
451 // /Wizard/1/URL "file://b"
452 // /Wizard/1/Title "MalWas"
453 // /Wizard/1/ImageIdentifier "icon_?"
454 // /Wizard/1/TargetName "_self"
455 //
456 // ... and so on ...
457
458 sal_uInt32 nItem = 0 ;
459 sal_uInt32 nPosition = 0 ;
460 OUString sName ;
461
462 // We must use these one instance object(!) to get information about installed modules.
463 // These information are used to filter menu entries wich need not installed modules ...
464 // Such entries shouldnt be available then!
465 // see impl_IsEntrySupported() too
466 SvtModuleOptions aModuleOptions;
467
468 // Get names/values for new menu.
469 // 4 subkeys for every item!
470 for( nItem=0; nItem<nNewCount; ++nItem )
471 {
472 SvtDynMenuEntry aItem ;
473 lValues[nPosition] >>= aItem.sURL ;
474 ++nPosition;
475 lValues[nPosition] >>= aItem.sTitle ;
476 ++nPosition;
477 lValues[nPosition] >>= aItem.sImageIdentifier ;
478 ++nPosition;
479 lValues[nPosition] >>= aItem.sTargetName ;
480 ++nPosition;
481 m_aNewMenu.AppendSetupEntry( aItem );
482 }
483
484 // Attention: Don't reset nPosition here!
485
486 // Get names/values for wizard menu.
487 // 4 subkeys for every item!
488 for( nItem=0; nItem<nWizardCount; ++nItem )
489 {
490 SvtDynMenuEntry aItem ;
491 lValues[nPosition] >>= aItem.sURL ;
492 ++nPosition;
493 lValues[nPosition] >>= aItem.sTitle ;
494 ++nPosition;
495 lValues[nPosition] >>= aItem.sImageIdentifier ;
496 ++nPosition;
497 lValues[nPosition] >>= aItem.sTargetName ;
498 ++nPosition;
499 m_aWizardMenu.AppendSetupEntry( aItem );
500 }
501
502 // Attention: Don't reset nPosition here!
503
504 // Get names/values for wizard menu.
505 // 4 subkeys for every item!
506 for( nItem=0; nItem<nHelpBookmarksCount; ++nItem )
507 {
508 SvtDynMenuEntry aItem ;
509 lValues[nPosition] >>= aItem.sURL ;
510 ++nPosition;
511 lValues[nPosition] >>= aItem.sTitle ;
512 ++nPosition;
513 lValues[nPosition] >>= aItem.sImageIdentifier ;
514 ++nPosition;
515 lValues[nPosition] >>= aItem.sTargetName ;
516 ++nPosition;
517 m_aHelpBookmarksMenu.AppendSetupEntry( aItem );
518 }
519
520 /*TODO: Not used in the moment! see Notify() ...
521 // Enable notification mechanism of ouer baseclass.
522 // We need it to get information about changes outside these class on ouer used configuration keys!
523 EnableNotification( lNames );
524 */
525 }
526
527 //*****************************************************************************************************************
528 // destructor
529 //*****************************************************************************************************************
530 SvtDynamicMenuOptions_Impl::~SvtDynamicMenuOptions_Impl()
531 {
532 // We must save our current values .. if user forget it!
533 if( IsModified() == sal_True )
534 {
535 Commit();
536 }
537 }
538
539 //*****************************************************************************************************************
540 // public method
541 //*****************************************************************************************************************
542 void SvtDynamicMenuOptions_Impl::Notify( const Sequence< OUString >& )
543 {
544 DBG_ASSERT( sal_False, "SvtDynamicMenuOptions_Impl::Notify()\nNot implemented yet! I don't know how I can handle a dynamical list of unknown properties ...\n" );
545 }
546
547 //*****************************************************************************************************************
548 // public method
549 //*****************************************************************************************************************
550 void SvtDynamicMenuOptions_Impl::Commit()
551 {
552 DBG_ERROR( "SvtDynamicMenuOptions_Impl::Commit()\nNot implemented yet!\n" );
553 /*
554 // Write all properties!
555 // Delete complete sets first.
556 ClearNodeSet( SETNODE_NEWMENU );
557 ClearNodeSet( SETNODE_WIZARDMENU );
558 ClearNodeSet( SETNODE_HELPBOOKMARKS );
559
560 MenuEntry aItem ;
561 OUString sNode ;
562 Sequence< PropertyValue > lPropertyValues( PROPERTYCOUNT );
563 sal_uInt32 nItem = 0 ;
564
565 // Copy "new" menu entries to save-list!
566 sal_uInt32 nNewCount = m_aNewMenu.size();
567 for( nItem=0; nItem<nNewCount; ++nItem )
568 {
569 aItem = m_aNewMenu[nItem];
570 // Format: "New/1/URL"
571 // "New/1/Title"
572 // ...
573 sNode = SETNODE_NEWMENU + PATHDELIMITER + PATHPREFIX + OUString::valueOf( (sal_Int32)nItem ) + PATHDELIMITER;
574
575 lPropertyValues[OFFSET_URL ].Name = sNode + PROPERTYNAME_URL ;
576 lPropertyValues[OFFSET_TITLE ].Name = sNode + PROPERTYNAME_TITLE ;
577 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Name = sNode + PROPERTYNAME_IMAGEIDENTIFIER ;
578 lPropertyValues[OFFSET_TARGETNAME ].Name = sNode + PROPERTYNAME_TARGETNAME ;
579
580 lPropertyValues[OFFSET_URL ].Value <<= aItem.sURL ;
581 lPropertyValues[OFFSET_TITLE ].Value <<= aItem.sTitle ;
582 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Value <<= aItem.sImageIdentifier ;
583 lPropertyValues[OFFSET_TARGETNAME ].Value <<= aItem.sTargetName ;
584
585 SetSetProperties( SETNODE_NEWMENU, lPropertyValues );
586 }
587
588 // Copy "wizard" menu entries to save-list!
589 sal_uInt32 nWizardCount = m_aWizardMenu.size();
590 for( nItem=0; nItem<nWizardCount; ++nItem )
591 {
592 aItem = m_aWizardMenu[nItem];
593 // Format: "Wizard/1/URL"
594 // "Wizard/1/Title"
595 // ...
596 sNode = SETNODE_WIZARDMENU + PATHDELIMITER + PATHPREFIX + OUString::valueOf( (sal_Int32)nItem ) + PATHDELIMITER;
597
598 lPropertyValues[OFFSET_URL ].Name = sNode + PROPERTYNAME_URL ;
599 lPropertyValues[OFFSET_TITLE ].Name = sNode + PROPERTYNAME_TITLE ;
600 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Name = sNode + PROPERTYNAME_IMAGEIDENTIFIER ;
601 lPropertyValues[OFFSET_TARGETNAME ].Name = sNode + PROPERTYNAME_TARGETNAME ;
602
603 lPropertyValues[OFFSET_URL ].Value <<= aItem.sURL ;
604 lPropertyValues[OFFSET_TITLE ].Value <<= aItem.sTitle ;
605 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Value <<= aItem.sImageIdentifier ;
606 lPropertyValues[OFFSET_TARGETNAME ].Value <<= aItem.sTargetName ;
607
608 SetSetProperties( SETNODE_WIZARDMENU, lPropertyValues );
609 }
610
611 // Copy help bookmarks entries to save-list!
612 sal_uInt32 nHelpBookmarksCount = m_aHelpBookmarksMenu.size();
613 for( nItem=0; nItem<nHelpBookmarksCount; ++nItem )
614 {
615 aItem = m_aHelpBookmarksMenu[nItem];
616 // Format: "HelpBookmarks/1/URL"
617 // "HelpBookmarks/1/Title"
618 // ...
619 sNode = SETNODE_HELPBOOKMARKS + PATHDELIMITER + PATHPREFIX + OUString::valueOf( (sal_Int32)nItem ) + PATHDELIMITER;
620
621 lPropertyValues[OFFSET_URL ].Name = sNode + PROPERTYNAME_URL ;
622 lPropertyValues[OFFSET_TITLE ].Name = sNode + PROPERTYNAME_TITLE ;
623 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Name = sNode + PROPERTYNAME_IMAGEIDENTIFIER ;
624 lPropertyValues[OFFSET_TARGETNAME ].Name = sNode + PROPERTYNAME_TARGETNAME ;
625
626 lPropertyValues[OFFSET_URL ].Value <<= aItem.sURL ;
627 lPropertyValues[OFFSET_TITLE ].Value <<= aItem.sTitle ;
628 lPropertyValues[OFFSET_IMAGEIDENTIFIER ].Value <<= aItem.sImageIdentifier ;
629 lPropertyValues[OFFSET_TARGETNAME ].Value <<= aItem.sTargetName ;
630
631 SetSetProperties( SETNODE_HELPBOOKMARKS, lPropertyValues );
632 }
633 */
634 }
635
636 //*****************************************************************************************************************
637 // public method
638 //*****************************************************************************************************************
639 void SvtDynamicMenuOptions_Impl::Clear( EDynamicMenuType eMenu )
640 {
641 switch( eMenu )
642 {
643 case E_NEWMENU : {
644 m_aNewMenu.Clear();
645 SetModified();
646 }
647 break;
648
649 case E_WIZARDMENU : {
650 m_aWizardMenu.Clear();
651 SetModified();
652 }
653 break;
654
655 case E_HELPBOOKMARKS : {
656 m_aHelpBookmarksMenu.Clear();
657 SetModified();
658 }
659 break;
660 }
661 }
662
663 //*****************************************************************************************************************
664 // public method
665 //*****************************************************************************************************************
666 Sequence< Sequence< PropertyValue > > SvtDynamicMenuOptions_Impl::GetMenu( EDynamicMenuType eMenu ) const
667 {
668 Sequence< Sequence< PropertyValue > > lReturn;
669 switch( eMenu )
670 {
671 case E_NEWMENU : {
672 lReturn = m_aNewMenu.GetList();
673 }
674 break;
675
676 case E_WIZARDMENU : {
677 lReturn = m_aWizardMenu.GetList();
678 }
679 break;
680
681 case E_HELPBOOKMARKS : {
682 lReturn = m_aHelpBookmarksMenu.GetList();
683 }
684 break;
685 }
686 return lReturn;
687 }
688
689 //*****************************************************************************************************************
690 // public method
691 //*****************************************************************************************************************
692 void SvtDynamicMenuOptions_Impl::AppendItem( EDynamicMenuType eMenu ,
693 const OUString& sURL ,
694 const OUString& sTitle ,
695 const OUString& sImageIdentifier,
696 const OUString& sTargetName )
697 {
698 SvtDynMenuEntry aItem( sURL, sTitle, sImageIdentifier, sTargetName );
699
700 switch( eMenu )
701 {
702 case E_NEWMENU : {
703 m_aNewMenu.AppendUserEntry( aItem );
704 SetModified();
705 }
706 break;
707
708 case E_WIZARDMENU : {
709 m_aWizardMenu.AppendUserEntry( aItem );
710 SetModified();
711 }
712 break;
713
714 case E_HELPBOOKMARKS : {
715 m_aHelpBookmarksMenu.AppendUserEntry( aItem );
716 SetModified();
717 }
718 break;
719 }
720 }
721
722 //*****************************************************************************************************************
723 // private method
724 //*****************************************************************************************************************
725 Sequence< OUString > SvtDynamicMenuOptions_Impl::impl_GetPropertyNames( sal_uInt32& nNewCount, sal_uInt32& nWizardCount, sal_uInt32& nHelpBookmarksCount )
726 {
727 // First get ALL names of current existing list items in configuration!
728 Sequence< OUString > lNewItems = GetNodeNames( SETNODE_NEWMENU );
729 Sequence< OUString > lWizardItems = GetNodeNames( SETNODE_WIZARDMENU );
730 Sequence< OUString > lHelpBookmarksItems = GetNodeNames( SETNODE_HELPBOOKMARKS );
731
732 // Get information about list counts ...
733 nNewCount = lNewItems.getLength ();
734 nWizardCount = lWizardItems.getLength ();
735 nHelpBookmarksCount = lHelpBookmarksItems.getLength();
736
737 // Sort and expand all three list to result list ...
738 Sequence< OUString > lProperties;
739 impl_SortAndExpandPropertyNames( lNewItems , lProperties, SETNODE_NEWMENU );
740 impl_SortAndExpandPropertyNames( lWizardItems , lProperties, SETNODE_WIZARDMENU );
741 impl_SortAndExpandPropertyNames( lHelpBookmarksItems, lProperties, SETNODE_HELPBOOKMARKS );
742
743 // Return result.
744 return lProperties;
745 }
746
747 //*****************************************************************************************************************
748 // private helper
749 //*****************************************************************************************************************
750 class CountWithPrefixSort
751 {
752 public:
753 int operator() ( const OUString& s1 ,
754 const OUString& s2 ) const
755 {
756 // Get order numbers from entry name without prefix.
757 // e.g. "m10" => 10
758 // "m5" => 5
759 sal_Int32 n1 = s1.copy( 1, s1.getLength()-1 ).toInt32();
760 sal_Int32 n2 = s2.copy( 1, s2.getLength()-1 ).toInt32();
761 // MUST be in [0,1] ... because it's a difference between
762 // insert-positions of given entries in sorted list!
763 return( n1<n2 );
764 }
765 };
766
767 class SelectByPrefix
768 {
769 public:
770 bool operator() ( const OUString& s ) const
771 {
772 // Prefer setup written entries by check first letter of given string. It must be a "s".
773 return( s.indexOf( PATHPREFIX_SETUP ) == 0 );
774 }
775 };
776
777 //*****************************************************************************************************************
778 // private method
779 //*****************************************************************************************************************
780 void SvtDynamicMenuOptions_Impl::impl_SortAndExpandPropertyNames( const Sequence< OUString >& lSource ,
781 Sequence< OUString >& lDestination ,
782 const OUString& sSetNode )
783 {
784 OUString sFixPath ;
785 vector< OUString > lTemp ;
786 sal_Int32 nSourceCount = lSource.getLength() ;
787 sal_Int32 nDestinationStep = lDestination.getLength() ; // start on end of current list ...!
788
789 lDestination.realloc( (nSourceCount*PROPERTYCOUNT)+nDestinationStep ); // get enough memory for copy operations after nDestination ...
790
791 // Copy all items to temp. vector to use fast sort operations :-)
792 for( sal_Int32 nSourceStep=0; nSourceStep<nSourceCount; ++nSourceStep )
793 lTemp.push_back( lSource[nSourceStep] );
794
795 // Sort all entries by number ...
796 stable_sort( lTemp.begin(), lTemp.end(), CountWithPrefixSort() );
797 // and split into setup & user written entries!
798 stable_partition( lTemp.begin(), lTemp.end(), SelectByPrefix() );
799
800 // Copy sorted entries to destination and expand every item with
801 // 4 supported sub properties.
802 for( vector< OUString >::const_iterator pItem =lTemp.begin() ;
803 pItem!=lTemp.end() ;
804 ++pItem )
805 {
806 sFixPath = sSetNode ;
807 sFixPath += PATHDELIMITER ;
808 sFixPath += *pItem ;
809 sFixPath += PATHDELIMITER ;
810
811 lDestination[nDestinationStep] = sFixPath ;
812 lDestination[nDestinationStep] += PROPERTYNAME_URL ;
813 ++nDestinationStep;
814 lDestination[nDestinationStep] = sFixPath ;
815 lDestination[nDestinationStep] += PROPERTYNAME_TITLE ;
816 ++nDestinationStep;
817 lDestination[nDestinationStep] = sFixPath ;
818 lDestination[nDestinationStep] += PROPERTYNAME_IMAGEIDENTIFIER ;
819 ++nDestinationStep;
820 lDestination[nDestinationStep] = sFixPath ;
821 lDestination[nDestinationStep] += PROPERTYNAME_TARGETNAME ;
822 ++nDestinationStep;
823 }
824 }
825
826 //*****************************************************************************************************************
827 // initialize static member
828 // DON'T DO IT IN YOUR HEADER!
829 // see definition for further informations
830 //*****************************************************************************************************************
831 SvtDynamicMenuOptions_Impl* SvtDynamicMenuOptions::m_pDataContainer = NULL ;
832 sal_Int32 SvtDynamicMenuOptions::m_nRefCount = 0 ;
833
834 //*****************************************************************************************************************
835 // constructor
836 //*****************************************************************************************************************
837 SvtDynamicMenuOptions::SvtDynamicMenuOptions()
838 {
839 // Global access, must be guarded (multithreading!).
840 MutexGuard aGuard( GetOwnStaticMutex() );
841 // Increase ouer refcount ...
842 ++m_nRefCount;
843 // ... and initialize ouer data container only if it not already exist!
844 if( m_pDataContainer == NULL )
845 {
846 m_pDataContainer = new SvtDynamicMenuOptions_Impl;
847 ItemHolder1::holdConfigItem(E_DYNAMICMENUOPTIONS);
848 }
849 }
850
851 //*****************************************************************************************************************
852 // destructor
853 //*****************************************************************************************************************
854 SvtDynamicMenuOptions::~SvtDynamicMenuOptions()
855 {
856 // Global access, must be guarded (multithreading!)
857 MutexGuard aGuard( GetOwnStaticMutex() );
858 // Decrease ouer refcount.
859 --m_nRefCount;
860 // If last instance was deleted ...
861 // we must destroy ouer static data container!
862 if( m_nRefCount <= 0 )
863 {
864 delete m_pDataContainer;
865 m_pDataContainer = NULL;
866 }
867 }
868
869 //*****************************************************************************************************************
870 // public method
871 //*****************************************************************************************************************
872 void SvtDynamicMenuOptions::Clear( EDynamicMenuType eMenu )
873 {
874 MutexGuard aGuard( GetOwnStaticMutex() );
875 m_pDataContainer->Clear( eMenu );
876 }
877
878 //*****************************************************************************************************************
879 // public method
880 //*****************************************************************************************************************
881 Sequence< Sequence< PropertyValue > > SvtDynamicMenuOptions::GetMenu( EDynamicMenuType eMenu ) const
882 {
883 MutexGuard aGuard( GetOwnStaticMutex() );
884 return m_pDataContainer->GetMenu( eMenu );
885 }
886
887 //*****************************************************************************************************************
888 // public method
889 //*****************************************************************************************************************
890 void SvtDynamicMenuOptions::AppendItem( EDynamicMenuType eMenu ,
891 const OUString& sURL ,
892 const OUString& sTitle ,
893 const OUString& sImageIdentifier,
894 const OUString& sTargetName )
895 {
896 MutexGuard aGuard( GetOwnStaticMutex() );
897 m_pDataContainer->AppendItem( eMenu, sURL, sTitle, sImageIdentifier, sTargetName );
898 }
899
900 //*****************************************************************************************************************
901 // private method
902 //*****************************************************************************************************************
903 Mutex& SvtDynamicMenuOptions::GetOwnStaticMutex()
904 {
905 // Initialize static mutex only for one time!
906 static Mutex* pMutex = NULL;
907 // If these method first called (Mutex not already exist!) ...
908 if( pMutex == NULL )
909 {
910 // ... we must create a new one. Protect follow code with the global mutex -
911 // It must be - we create a static variable!
912 MutexGuard aGuard( Mutex::getGlobalMutex() );
913 // We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
914 if( pMutex == NULL )
915 {
916 // Create the new mutex and set it for return on static variable.
917 static Mutex aMutex;
918 pMutex = &aMutex;
919 }
920 }
921 // Return new created or already existing mutex object.
922 return *pMutex;
923 }
vba interoperability for OOo