include/sfx2/styfitem.hxx

   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 INCLUDED_SFX2_STYFITEM_HXX
  20 #define INCLUDED_SFX2_STYFITEM_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <sal/config.h>
  24 #include <sfx2/dllapi.h>
  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     OUString 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     OUString        aText;
  44     OUString        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 OUString& GetText() const { return aText; }
  54     const OUString& GetHelpText() const { return aHelpText; }
  55     SfxStyleFamily  GetFamily() const { return (SfxStyleFamily)nFamily; }
  56     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                         SfxStyleFamilies( const ResId &);
  72                         SfxStyleFamilies( ) {};
  73                         ~SfxStyleFamilies();
  74
  75     size_t              size() const
  76                         { return aEntryList.size(); }
  77
  78     const SfxStyleFamilyItem* at(size_t nIdx) const
  79                         { return (SfxStyleFamilyItem*)(aEntryList.empty() ? NULL : aEntryList[nIdx]); }
  80
  81     /** updates the images of all single SfxStyleFamilyItems with new images from the given resource
  82
  83         <p>The resource must contain a local image lists, with the id beeing the integer equivalent for the
  84         requested bitmap mode, incremented by 1.</p>
  85
  86         <p>Usually, you will use the same resource which originally constructed the object.</p>
  87
  88         @return
  89             <TRUE/> if an image list for the requested mode could be found in the given resource.
  90     */
  91     sal_Bool    updateImages( const ResId& _rId );
  92 };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */