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             : #ifndef _SFX_STYFITEM_HXX
      20             : #define _SFX_STYFITEM_HXX
      21             : 
      22             : #include "sal/config.h"
      23             : #include "sfx2/dllapi.h"
      24             : 
      25             : #include <vcl/bitmap.hxx>
      26             : #include <vcl/image.hxx>
      27             : #include <tools/rc.hxx>
      28             : #include <rsc/rscsfx.hxx>
      29             : #include <vector>
      30             : 
      31             : struct SfxFilterTupel {
      32             :     String aName;
      33             :     sal_uInt16 nFlags;
      34             : };
      35             : typedef ::std::vector< SfxFilterTupel* > SfxStyleFilter;
      36             : 
      37             : // CLASS -----------------------------------------------------------------
      38             : 
      39             : class SfxStyleFamilyItem: public Resource
      40             : {
      41             :     Image           aImage;
      42             :     Bitmap          aBitmap;
      43             :     String          aText;
      44             :     String          aHelpText;
      45             :     sal_uInt16          nFamily;
      46             :     SfxStyleFilter  aFilterList;
      47             : 
      48             : public:
      49             :                     SfxStyleFamilyItem( const ResId &rId );
      50             :                     ~SfxStyleFamilyItem();
      51             : 
      52             :     const Bitmap&   GetBitmap() const { return aBitmap; }
      53             :     const String&   GetText() const { return aText; }
      54             :     const String&   GetHelpText() const { return aHelpText; }
      55           0 :     SfxStyleFamily  GetFamily() const { return (SfxStyleFamily)nFamily; }
      56           0 :     const SfxStyleFilter& GetFilterList() const { return aFilterList; }
      57             :     const Image&    GetImage() const { return aImage; }
      58             : 
      59             :     // --------------------------------------------------------------------
      60             :     class GrantAccess { friend class SfxStyleFamilies; };
      61             :     void            SetImage( const Image& _rImg ) { aImage = _rImg; }
      62             : };
      63             : 
      64             : typedef ::std::vector< SfxStyleFamilyItem* > SfxStyleFamilyList;
      65             : 
      66             : class SFX2_DLLPUBLIC SfxStyleFamilies: public Resource
      67             : {
      68             :     SfxStyleFamilyList  aEntryList;
      69             : 
      70             : public:
      71             :     /** ctor
      72             :         <p>Will automatically call updateImages with BMP_COLOR_NORMAL.</p>
      73             :     */
      74             :                         SfxStyleFamilies( const ResId &);
      75             :                         SfxStyleFamilies( ) {};
      76             :                         ~SfxStyleFamilies();
      77             : 
      78           0 :     size_t              size() const
      79           0 :                         { return aEntryList.size(); }
      80             : 
      81           0 :     const SfxStyleFamilyItem* at(size_t nIdx) const
      82           0 :                         { return (SfxStyleFamilyItem*)(aEntryList.empty() ? NULL : aEntryList[nIdx]); }
      83             : 
      84             :     /** updates the images of all single SfxStyleFamilyItems with new images from the given resource
      85             : 
      86             :         <p>The resource must contain a local image lists, with the id beeing the integer equivalent for the
      87             :         requested bitmap mode, incremented by 1.</p>
      88             : 
      89             :         <p>Usually, you will use the same resource which originally constructed the object.</p>
      90             : 
      91             :         @return
      92             :             <TRUE/> if an image list for the requested mode could be found in the given resource.
      93             :     */
      94             :     sal_Bool    updateImages( const ResId& _rId );
      95             : };
      96             : 
      97             : #endif
      98             : 
      99             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */