libreoffice/autodoc/inc/ary/idl/i_enum.hxx

/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: i_enum.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 16:07:47 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef ARY_IDL_I_ENUM_HXX
#define ARY_IDL_I_ENUM_HXX




// USED SERVICES
    // BASE CLASSES
#include <ary/idl/i_ce.hxx>
    // COMPONENTS
    // PARAMETERS


namespace ary
{
namespace idl
{


namespace ifc_enum
{
    struct attr;
}



/*  OPEN?
*/

/** @resp
    Represents an IDL enum.
*/
class Enum : public CodeEntity
{
  public:
    enum E_ClassId { class_id = 2005 };
    // LIFECYCLE
                        Enum(
                            const String &      i_sName,
                            Ce_id               i_nOwner );
                        ~Enum();
    // ACCESS
    void                Add_Value(
                            Ce_id               i_nValue );
  private:
    // Interface ary::RepositoryEntity
    virtual RCid        inq_ClassId() const;

    // Interface CodeEntity
    virtual void            do_Visit_CeHost(CeHost & o_rHost) const;
    virtual const String &  inq_LocalName() const;
    virtual Ce_id           inq_NameRoom() const;
    virtual Ce_id           inq_Owner() const;
    virtual E_SightLevel    inq_SightLevel() const;

    // Locals
    typedef std::vector<Ce_id>   ValueList;
    friend struct ifc_enum::attr;

    // DATA
    String              sName;
    Ce_id               nOwner;

    ValueList           aValues;
};



// IMPLEMENTATION


inline void
Enum::Add_Value( Ce_id i_nValue )
    { aValues.push_back(i_nValue); }


}   // namespace idl
}   // namespace ary


#endif