binfilter/inc/bf_svtools/menuoptions.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: menuoptions.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_MENUOPTIONS_HXX
  31 #define INCLUDED_SVTOOLS_MENUOPTIONS_HXX
  32
  33 //_________________________________________________________________________________________________________________
  34 //      includes
  35 //_________________________________________________________________________________________________________________
  36
  37 #ifndef _SAL_TYPES_H_
  38 #include <sal/types.h>
  39 #endif
  40
  41 #ifndef _OSL_MUTEX_HXX_
  42 #include <osl/mutex.hxx>
  43 #endif
  44
  45 #ifndef INCLUDED_SVTOOLS_OPTIONS_HXX
  46 #include <bf_svtools/options.hxx>
  47 #endif
  48
  49 //_________________________________________________________________________________________________________________
  50 //      forward declarations
  51 //_________________________________________________________________________________________________________________
  52
  53 /*-************************************************************************************************************//**
  54     @short                      forward declaration to our private date container implementation
  55     @descr                      We use these class as internal member to support small memory requirements.
  56                     You can create the container if it is neccessary. The class which use these mechanism
  57                     is faster and smaller then a complete implementation!
  58 *//*-*************************************************************************************************************/
  59
  60 class Link;
  61
  62 namespace binfilter
  63 {
  64 class SvtMenuOptions_Impl;
  65
  66 //_________________________________________________________________________________________________________________
  67 //      declarations
  68 //_________________________________________________________________________________________________________________
  69
  70 /*-************************************************************************************************************//**
  71     @short                      collect informations about menu features
  72     @descr          -
  73
  74     @implements         -
  75     @base                       -
  76
  77     @devstatus          ready to use
  78 *//*-*************************************************************************************************************/
  79
  80 class  SvtMenuOptions: public Options
  81 {
  82     //-------------------------------------------------------------------------------------------------------------
  83     //  public methods
  84     //-------------------------------------------------------------------------------------------------------------
  85
  86     public:
  87
  88         //---------------------------------------------------------------------------------------------------------
  89         //      constructor / destructor
  90         //---------------------------------------------------------------------------------------------------------
  91
  92         /*-****************************************************************************************************//**
  93             @short              standard constructor and destructor
  94             @descr              This will initialize an instance with default values.
  95                         We implement these class with a refcount mechanism! Every instance of this class increase it
  96                         at create and decrease it at delete time - but all instances use the same data container!
  97                         He is implemented as a static member ...
  98
  99             @seealso    member m_nRefCount
 100             @seealso    member m_pDataContainer
 101
 102             @param              -
 103             @return             -
 104
 105             @onerror    -
 106         *//*-*****************************************************************************************************/
 107
 108          SvtMenuOptions();
 109         virtual ~SvtMenuOptions();
 110
 111     //-------------------------------------------------------------------------------------------------------------
 112     //  private methods
 113     //-------------------------------------------------------------------------------------------------------------
 114
 115     private:
 116
 117         /*-****************************************************************************************************//**
 118             @short              return a reference to a static mutex
 119             @descr              These class is partially threadsafe (for de-/initialization only).
 120                         All access methods are'nt safe!
 121                         We create a static mutex only for one ime and use at different times.
 122
 123             @seealso    -
 124
 125             @param              -
 126             @return             A reference to a static mutex member.
 127
 128             @onerror    -
 129         *//*-*****************************************************************************************************/
 130
 131          static ::osl::Mutex& GetOwnStaticMutex();
 132
 133     //-------------------------------------------------------------------------------------------------------------
 134     //  private member
 135     //-------------------------------------------------------------------------------------------------------------
 136
 137     private:
 138
 139         /*Attention
 140
 141             Don't initialize these static member in these header!
 142             a) Double dfined symbols will be detected ...
 143             b) and unresolved externals exist at linking time.
 144             Do it in your source only.
 145          */
 146
 147         static SvtMenuOptions_Impl*     m_pDataContainer        ;       /// impl. data container as dynamic pointer for smaller memory requirements!
 148         static sal_Int32                        m_nRefCount                     ;       /// internal ref count mechanism
 149
 150 };              // class SvtMenuOptions
 151
 152 }
 153
 154 #endif  // #ifndef INCLUDED_SVTOOLS_MENUOPTIONS_HXX