autodoc/inc/ary/idl/i_param.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 ARY_IDL_I_PARAM_HXX
  21 #define ARY_IDL_I_PARAM_HXX
  22
  23 // BASE CLASSES
  24 #include <ary/idl/i_types4idl.hxx>
  25
  26
  27
  28
  29 namespace ary
  30 {
  31 namespace idl
  32 {
  33
  34
  35 /** Represents a parameter in an IDL function.
  36 */
  37 class Parameter
  38 {
  39   public:
  40     // LIFECYCLE
  41                         Parameter(
  42                             const String &      i_sName,
  43                             Type_id             i_nType,
  44                             E_ParameterDirection
  45                                                 i_eDirection );
  46                         ~Parameter();
  47
  48     // INQUIRY
  49     const String &      Name() const            { return sName; }
  50     Type_id             Type() const            { return nType; }
  51     E_ParameterDirection
  52                         Direction() const       { return eDirection; }
  53
  54   private:
  55     // DATA
  56     String              sName;
  57     Type_id             nType;
  58     E_ParameterDirection
  59                         eDirection;
  60 };
  61
  62
  63
  64
  65 }   // namespace idl
  66 }   // namespace ary
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */