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