svx/source/inc/stringlistresource.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
  20 #ifndef INCLUDED_SVX_SOURCE_INC_STRINGLISTRESOURCE_HXX
  21 #define INCLUDED_SVX_SOURCE_INC_STRINGLISTRESOURCE_HXX
  22
  23 #include <tools/rc.hxx>
  24 #include <svx/svxdllapi.h>
  25
  26 #include <memory>
  27
  28
  29 namespace svx
  30 {
  31
  32     /** loads a list of strings from a resource, where the resource is of type RSC_RESOURCE,
  33         and has sub resources of type string, numbered from 1 to n
  34     */
  35     class StringListResource : public Resource
  36     {
  37     public:
  38         SVX_DLLPUBLIC StringListResource( const ResId& _rResId );
  39         SVX_DLLPUBLIC ~StringListResource();
  40
  41         inline void get( ::std::vector< OUString >& _rStrings )
  42         {
  43             _rStrings = m_aStrings;
  44         }
  45
  46
  47         /** returns the OUString with a given local resource id
  48
  49             @param  _nResId
  50                 The resource id. It will not be checked if this id exists.
  51
  52             @return OUString
  53                 The string.
  54         */
  55         OUString getString( sal_uInt16 _nResId )
  56         {
  57             return ResId(_nResId, *m_pResMgr).toString();
  58         }
  59
  60         size_t  size() const    { return m_aStrings.size(); }
  61         bool    empty() const   { return m_aStrings.empty(); }
  62
  63         const OUString& operator[]( size_t _index ) const { return m_aStrings[ _index ]; }
  64
  65     private:
  66         ::std::vector< OUString > m_aStrings;
  67     };
  68
  69
  70 }
  71
  72
  73 #endif // INCLUDED_SVX_SOURCE_INC_STRINGLISTRESOURCE_HXX
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */