autodoc/inc/ary/object.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: object.hxx,v $
  10  * $Revision: 1.3 $
  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_OBJECT_HXX
  32 #define ARY_OBJECT_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <cosv/tpl/processor.hxx>
  39     // COMPONENTS
  40     // PARAMETERS
  41 #include <ary/types.hxx>
  42
  43
  44 namespace ary
  45 {
  46
  47
  48 /** Interface for every class, that is stored within the
  49     Autodoc Repository.
  50 */
  51 class Object : public csv::ConstProcessorClient
  52 {
  53   public:
  54     virtual             ~Object() {}
  55
  56     /// @return Type id of most derived class.
  57     ClassId             AryClass() const;
  58
  59   private:
  60     virtual ClassId     get_AryClass() const = 0;
  61 };
  62
  63
  64
  65 inline ClassId
  66 Object::AryClass() const
  67 {
  68     return get_AryClass();
  69 }
  70
  71
  72 }   // namespace ary
  73 #endif