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