extensions/source/propctrlr/enumrepresentation.hxx

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