include/cppu/EnvDcp.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_CPPU_ENVDCP_HXX
  21 #define INCLUDED_CPPU_ENVDCP_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <uno/EnvDcp.h>
  25
  26
  27 namespace cppu
  28 {
  29 namespace EnvDcp
  30 {
  31 /** Get the OBI type part of an environment descriptor.
  32     (http://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Environment_Descriptor)
  33
  34     @param  rEnvDcp        the Environment Descriptor
  35     @return                the OBI type
  36     @since UDK 3.2.7
  37 */
  38 inline rtl::OUString getTypeName(rtl::OUString const & rEnvDcp)
  39 {
  40     rtl::OUString typeName;
  41
  42     uno_EnvDcp_getTypeName(rEnvDcp.pData, &typeName.pData);
  43
  44     return typeName;
  45 }
  46
  47 /** Get the purpose part of an environment descriptor.
  48     (http://wiki.openoffice.org/wiki/Uno/Binary/Spec/Environment_Descriptor)
  49
  50     @param  rEnvDcp        the Environment Descriptor
  51     @return                the purpose
  52     @since UDK 3.2.7
  53 */
  54 inline rtl::OUString getPurpose(rtl::OUString const & rEnvDcp)
  55 {
  56     rtl::OUString purpose;
  57
  58     uno_EnvDcp_getPurpose(rEnvDcp.pData, &purpose.pData);
  59
  60     return purpose;
  61 }
  62
  63 }
  64 }
  65
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */