binfilter/inc/bf_svtools/dynamicmenuoptions.hxx

   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.hxx,v $
  10  * $Revision: 1.4 $
  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 #ifndef INCLUDED_SVTOOLS_DYNAMICMENUOPTIONS_HXX
  31 #define INCLUDED_SVTOOLS_DYNAMICMENUOPTIONS_HXX
  32
  33 #ifndef _SAL_TYPES_H_
  34 #include <sal/types.h>
  35 #endif
  36
  37 #ifndef _OSL_MUTEX_HXX_
  38 #include <osl/mutex.hxx>
  39 #endif
  40
  41 #ifndef _COM_SUN_STAR_UNO_SEQUENCE_H_
  42 #include <com/sun/star/uno/Sequence.h>
  43 #endif
  44
  45 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
  46 #include <com/sun/star/beans/PropertyValue.hpp>
  47 #endif
  48
  49 #ifndef INCLUDED_SVTOOLS_OPTIONS_HXX
  50 #include <bf_svtools/options.hxx>
  51 #endif
  52
  53 namespace binfilter {
  54
  55 //_________________________________________________________________________________________________________________
  56 //      types, enums, ...
  57 //_________________________________________________________________________________________________________________
  58
  59 /*-************************************************************************************************************//**
  60         @descr                  The method GetList() returns a list of property values.
  61                                         Use follow defines to seperate values by names.
  62 *//*-*************************************************************************************************************/
  63 #define DYNAMICMENU_PROPERTYNAME_URL                    ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("URL"             ))
  64 #define DYNAMICMENU_PROPERTYNAME_TITLE                  ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("Title"           ))
  65 #define DYNAMICMENU_PROPERTYNAME_IMAGEIDENTIFIER        ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("ImageIdentifier" ))
  66 #define DYNAMICMENU_PROPERTYNAME_TARGETNAME             ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("TargetName"      ))
  67
  68 /*-************************************************************************************************************//**
  69     @descr          You can use these enum values to specify right menu if you call our interface methods.
  70 *//*-*************************************************************************************************************/
  71 enum EDynamicMenuType
  72 {
  73     E_NEWMENU       =   0,
  74     E_WIZARDMENU    =   1,
  75     E_HELPBOOKMARKS =   2
  76 };
  77 //_________________________________________________________________________________________________________________
  78 //      forward declarations
  79 //_________________________________________________________________________________________________________________
  80
  81 /*-************************************************************************************************************//**
  82         @short                  forward declaration to our private date container implementation
  83         @descr                  We use these class as internal member to support small memory requirements.
  84                                         You can create the container if it is neccessary. The class which use these mechanism
  85                                         is faster and smaller then a complete implementation!
  86 *//*-*************************************************************************************************************/
  87
  88 class SvtDynamicMenuOptions_Impl;
  89
  90 //_________________________________________________________________________________________________________________
  91 //      declarations
  92 //_________________________________________________________________________________________________________________
  93
  94 /*-************************************************************************************************************//**
  95     @short          collect informations about dynamic menus
  96     @descr          Make it possible to configure dynamic menu structures of menus like "new" or "wizard".
  97
  98         @implements             -
  99         @base                   -
 100
 101         @devstatus              ready to use
 102 *//*-*************************************************************************************************************/
 103
 104 class  SvtDynamicMenuOptions: public Options
 105 {
 106         //-------------------------------------------------------------------------------------------------------------
 107         //      public methods
 108         //-------------------------------------------------------------------------------------------------------------
 109
 110         public:
 111
 112                 //---------------------------------------------------------------------------------------------------------
 113                 //      constructor / destructor
 114                 //---------------------------------------------------------------------------------------------------------
 115
 116                 /*-****************************************************************************************************//**
 117                         @short          standard constructor and destructor
 118                         @descr          This will initialize an instance with default values.
 119                                                 We implement these class with a refcount mechanism! Every instance of this class increase it
 120                                                 at create and decrease it at delete time - but all instances use the same data container!
 121                                                 He is implemented as a static member ...
 122
 123                         @seealso        member m_nRefCount
 124                         @seealso        member m_pDataContainer
 125
 126                         @param          -
 127                         @return         -
 128
 129                         @onerror        -
 130                 *//*-*****************************************************************************************************/
 131
 132          SvtDynamicMenuOptions();
 133         virtual ~SvtDynamicMenuOptions();
 134
 135                 //---------------------------------------------------------------------------------------------------------
 136                 //      interface
 137                 //---------------------------------------------------------------------------------------------------------
 138
 139         //-------------------------------------------------------------------------------------------------------------
 140         //      private methods
 141         //-------------------------------------------------------------------------------------------------------------
 142
 143         private:
 144
 145                 /*-****************************************************************************************************//**
 146                         @short          return a reference to a static mutex
 147                         @descr          These class is partially threadsafe (for de-/initialization only).
 148                                                 All access methods are'nt safe!
 149                                                 We create a static mutex only for one ime and use at different times.
 150
 151                         @seealso        -
 152
 153                         @param          -
 154                         @return         A reference to a static mutex member.
 155
 156                         @onerror        -
 157                 *//*-*****************************************************************************************************/
 158
 159                  static ::osl::Mutex& GetOwnStaticMutex();
 160
 161         //-------------------------------------------------------------------------------------------------------------
 162         //      private member
 163         //-------------------------------------------------------------------------------------------------------------
 164
 165         private:
 166
 167                 /*Attention
 168
 169                         Don't initialize these static member in these header!
 170                         a) Double dfined symbols will be detected ...
 171                         b) and unresolved externals exist at linking time.
 172                         Do it in your source only.
 173                  */
 174
 175         static SvtDynamicMenuOptions_Impl* m_pDataContainer    ;   /// impl. data container as dynamic pointer for smaller memory requirements!
 176         static sal_Int32             m_nRefCount         ;   /// internal ref count mechanism
 177
 178 };      // class SvtDynamicMenuOptions
 179
 180 }
 181
 182 #endif  // #ifndef INCLUDED_SVTOOLS_DYNAMICMENUOPTIONS_HXX