Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_TOOLS_RESID_HXX
      21             : #define INCLUDED_TOOLS_RESID_HXX
      22             : 
      23             : #include <osl/diagnose.h>
      24             : #include <rtl/ustring.hxx>
      25             : #include <tools/solar.h>
      26             : #include <tools/toolsdllapi.h>
      27             : 
      28             : struct RSHEADER_TYPE;
      29             : typedef sal_uInt32 RESOURCE_TYPE;
      30             : #define RSC_NOTYPE              0x100
      31             : #define RSC_DONTRELEASE         (sal_uInt32(1U << 31))
      32             : 
      33             : class ResMgr;
      34             : 
      35             : class ResId
      36             : {
      37             :     /*
      38             :     consider two cases: either m_pResource is valid and points
      39             :     two a resource data buffer; then m_nResId and m_pResMgr are
      40             :     not used and may be 0 resp. NULL
      41             :     or m_pResource is NULL, the m_nResId and m_pResMgr must be valid.
      42             :     In this case the highest bit if set decides whether to
      43             :     not to release the Resource context after loading this id
      44             :     */
      45             :     RSHEADER_TYPE*          m_pResource;
      46             : 
      47             :     mutable sal_uInt32      m_nResId;      // Resource Identifier
      48             :     mutable RESOURCE_TYPE   m_nRT;         // type for loading (mutable to be set later)
      49             :     mutable ResMgr *        m_pResMgr;     // load from this ResMgr (mutable for setting on demand)
      50             :     mutable RESOURCE_TYPE   m_nRT2;        // type for loading (supersedes m_nRT)
      51             :     mutable sal_uInt32      m_nWinBits;    // container for original style bits on a window in a resource
      52             : 
      53     1565118 :     void ImplInit( sal_uInt32 nId, ResMgr& rMgr, RSHEADER_TYPE* pRes )
      54             :     {
      55     1565118 :         m_pResource = pRes; m_nResId = nId; m_nRT = RSC_NOTYPE; m_pResMgr = &rMgr; m_nRT2 = RSC_NOTYPE; m_nWinBits = 0;
      56             :         OSL_ENSURE( m_pResMgr != NULL, "ResId without ResMgr created" );
      57     1565118 :     }
      58             : 
      59             : public:
      60       40388 :     ResId( RSHEADER_TYPE * pRc, ResMgr& rMgr )
      61             :     {
      62       40388 :         ImplInit( 0, rMgr, pRc );
      63       40388 :     }
      64     1524730 :     ResId( sal_uInt32 nId, ResMgr& rMgr )
      65             :     {
      66     1524730 :         ImplInit( nId, rMgr, NULL );
      67     1524730 :     }
      68             : 
      69             :     sal_uInt32 GetWinBits() const { return m_nWinBits; }
      70        5794 :     void SetWinBits( sal_uInt32 nBits ) const { m_nWinBits = nBits; }
      71             : 
      72           0 :     RESOURCE_TYPE   GetRT() const { return m_nRT; }
      73             : 
      74             :     /** Set the type if not already set. Ask for type with GetRT()
      75             : 
      76             :     [Example]
      77             :     ResId aId( 1000 );
      78             :     aId.SetRT( RSC_WINDOW );    // settype window Window
      79             :     aId.SetRT( RSC_BUTTON );    // will not set type Button
      80             :     //aId.GetRT() == RSC_WINDOW is true
      81             : 
      82             :     @see
      83             :     ResId::GetRT2(), ResId::GetRT()
      84             :     */
      85     1639517 :     const ResId &   SetRT( RESOURCE_TYPE nType ) const
      86             :     {
      87     1639517 :         if( RSC_NOTYPE == m_nRT )
      88     1553701 :             m_nRT = nType;
      89     1639517 :         return *this;
      90             :     }
      91             : 
      92             :     /** Get the effective type (m_nRT2 or m_nRT1)
      93             : 
      94             :     A second resource type is used to supersede settings
      95             :     of the base class ( e.g. Window )
      96             :     */
      97     1639517 :     RESOURCE_TYPE   GetRT2() const
      98             :     {
      99     1639517 :         return (RSC_NOTYPE == m_nRT2) ? m_nRT : m_nRT2;
     100             :     }
     101             : 
     102             :     /** Set the superceding type. Ask spcifically for it with GetRT2()
     103             : 
     104             :     SetRT2() may only be called if no derived class calls SetRT in its
     105             :     Resource constructor.
     106             :     */
     107             :     const ResId &   SetRT2( RESOURCE_TYPE nTyp ) const
     108             :     {
     109             :         if( RSC_NOTYPE == m_nRT2 )
     110             :             m_nRT2 = nTyp;
     111             :         return *this;
     112             :     }
     113             : 
     114     3250357 :     ResMgr *        GetResMgr() const { return m_pResMgr; }
     115           0 :     const ResId &   SetResMgr( ResMgr * pMgr ) const
     116             :     {
     117           0 :         m_pResMgr = pMgr;
     118             :         OSL_ENSURE( m_pResMgr != NULL, "invalid ResMgr set on ResId" );
     119           0 :         return *this;
     120             :     }
     121             : 
     122           0 :     const ResId &  SetAutoRelease(bool bRelease) const
     123             :     {
     124           0 :         if( bRelease )
     125           0 :             m_nResId &= ~RSC_DONTRELEASE;
     126             :         else
     127           0 :             m_nResId |= RSC_DONTRELEASE;
     128           0 :         return *this;
     129             :     }
     130             : 
     131     1541749 :     bool        IsAutoRelease()  const
     132     1541749 :         { return !(m_nResId & RSC_DONTRELEASE); }
     133             : 
     134     1756054 :     sal_uInt32      GetId()        const { return m_nResId & ~RSC_DONTRELEASE; }
     135     1639517 :     RSHEADER_TYPE*  GetpResource() const { return m_pResource; }
     136             : 
     137             :     TOOLS_DLLPUBLIC OUString toString() const;
     138      119805 :     TOOLS_DLLPUBLIC operator OUString() const { return toString(); }
     139             : };
     140             : 
     141             : #endif
     142             : 
     143             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */