extensions/source/propctrlr/enumrepresentation.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  29 #define EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  30
  31 /** === begin UNO includes === **/
  32 #include <com/sun/star/uno/Any.hxx>
  33 /** === end UNO includes === **/
  34 #include <rtl/ref.hxx>
  35 #include <rtl/ustring.hxx>
  36
  37 #include <vector>
  38
  39 //........................................................................
  40 namespace pcr
  41 {
  42 //........................................................................
  43
  44     //====================================================================
  45     //= IPropertyEnumRepresentation
  46     //====================================================================
  47     class SAL_NO_VTABLE IPropertyEnumRepresentation : public ::rtl::IReference
  48     {
  49     public:
  50         /** retrieves all descriptions of all possible values of the enumeration property
  51         */
  52         virtual ::std::vector< ::rtl::OUString > SAL_CALL getDescriptions(
  53             ) const = 0;
  54
  55         /** converts a given description into a property value
  56         */
  57         virtual void SAL_CALL getValueFromDescription(
  58                 const ::rtl::OUString& _rDescription,
  59                 ::com::sun::star::uno::Any& _out_rValue
  60             ) const = 0;
  61
  62         /** converts a given property value into a description
  63         */
  64         virtual ::rtl::OUString SAL_CALL getDescriptionForValue(
  65                 const ::com::sun::star::uno::Any& _rEnumValue
  66             ) const = 0;
  67
  68         virtual ~IPropertyEnumRepresentation() { };
  69     };
  70
  71 //........................................................................
  72 } // namespace pcr
  73 //........................................................................
  74
  75 #endif // EXTENSIONS_SOURCE_PROPCTRLR_ENUMREPRESENTATION_HXX
  76