autodoc/inc/ary/idl/i_param.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_IDL_I_PARAM_HXX
  30 #define ARY_IDL_I_PARAM_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/idl/i_types4idl.hxx>
  34
  35
  36
  37
  38 namespace ary
  39 {
  40 namespace idl
  41 {
  42
  43
  44 /** Represents a parameter in an IDL function.
  45 */
  46 class Parameter
  47 {
  48   public:
  49     // LIFECYCLE
  50                         Parameter(
  51                             const String &      i_sName,
  52                             Type_id             i_nType,
  53                             E_ParameterDirection
  54                                                 i_eDirection );
  55                         ~Parameter();
  56
  57     // INQUIRY
  58     const String &      Name() const            { return sName; }
  59     Type_id             Type() const            { return nType; }
  60     E_ParameterDirection
  61                         Direction() const       { return eDirection; }
  62
  63   private:
  64     // DATA
  65     String              sName;
  66     Type_id             nType;
  67     E_ParameterDirection
  68                         eDirection;
  69 };
  70
  71
  72
  73
  74 }   // namespace idl
  75 }   // namespace ary
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */