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