autodoc/source/ary/idl/it_sequence.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: it_sequence.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 ARY_IDL_IT_SEQUENCE_HXX
  32 #define ARY_IDL_IT_SEQUENCE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_type.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44
  45
  46 /** A sequence (an array of a type).
  47 */
  48 class Sequence : public Type
  49 {
  50   public:
  51     enum E_ClassId { class_id = 2202 };
  52
  53     // LIFECYCLE
  54                         Sequence(
  55                             Type_id             i_nRelatedType );
  56     virtual             ~Sequence();
  57
  58     // INQUIRY
  59     Type_id             RelatedType() const     { return nRelatedType; }
  60
  61   private:
  62     // Interface csv::ConstProcessorClient:
  63     virtual void        do_Accept(
  64                             csv::ProcessorIfc & io_processor ) const;
  65     // Interface Object:
  66     virtual ClassId     get_AryClass() const;
  67
  68     // Interface Type:
  69     virtual void        inq_Get_Text(
  70                             StringVector &      o_module,
  71                             String &            o_name,
  72                             Ce_id &             o_nRelatedCe,
  73                             int &               o_nSequemceCount,
  74                             const Gate &        i_rGate ) const;
  75     virtual const Type &
  76                         inq_FirstEnclosedNonSequenceType(
  77                             const Gate &        i_rGate ) const;
  78     // DATA
  79     Type_id             nRelatedType;
  80 };
  81
  82
  83
  84
  85 }   // namespace idl
  86 }   // namespace ary
  87 #endif