extensions/source/propctrlr/enumrepresentation.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_EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  22
  23 #include <com/sun/star/uno/Any.hxx>
  24 #include <rtl/ref.hxx>
  25 #include <rtl/ustring.hxx>
  26 #include <salhelper/simplereferenceobject.hxx>
  27
  28 #include <vector>
  29
  30
  31 namespace pcr
  32 {
  33
  34
  35
  36     //= IPropertyEnumRepresentation
  37
  38     class SAL_NO_VTABLE IPropertyEnumRepresentation : public salhelper::SimpleReferenceObject
  39     {
  40     public:
  41         /** retrieves all descriptions of all possible values of the enumeration property
  42         */
  43         virtual ::std::vector< OUString > SAL_CALL getDescriptions(
  44             ) const = 0;
  45
  46         /** converts a given description into a property value
  47         */
  48         virtual void SAL_CALL getValueFromDescription(
  49                 const OUString& _rDescription,
  50                 ::com::sun::star::uno::Any& _out_rValue
  51             ) const = 0;
  52
  53         /** converts a given property value into a description
  54         */
  55         virtual OUString SAL_CALL getDescriptionForValue(
  56                 const ::com::sun::star::uno::Any& _rEnumValue
  57             ) const = 0;
  58
  59         virtual ~IPropertyEnumRepresentation() { };
  60     };
  61
  62
  63 } // namespace pcr
  64
  65
  66 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */