autodoc/inc/ary/cessentl.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: cessentl.hxx,v $
  10  * $Revision: 1.5 $
  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_CESSENTL_HXX
  32 #define ARY_CESSENTL_HXX
  33 //  KORR_DEPRECATED_3.0
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40 #include <ary/cpp/c_types4cpp.hxx>
  41 #include <ary/loc/loc_types4loc.hxx>
  42
  43
  44
  45 namespace ary
  46 {
  47 namespace cpp
  48 {
  49
  50
  51 class CeEssentials
  52 {       // Non inline functions are implemented in ceworker.cxx .
  53   public:
  54     // LIFECYCLE
  55                         CeEssentials();
  56                         CeEssentials(
  57                             const String  &     i_sLocalName,
  58                             Ce_id               i_nOwner,
  59                             loc::Le_id          i_nLocation );
  60                         ~CeEssentials();
  61     // INQUIRY
  62     const String  &     LocalName() const;
  63     Ce_id                   Owner() const;
  64     loc::Le_id          Location() const;
  65
  66     // ACCESS
  67   private:
  68     String              sLocalName;
  69     Ce_id                           nOwner;
  70     loc::Le_id          nLocation;
  71 };
  72
  73
  74
  75 // IMPLEMENTATION
  76 inline const String     &
  77 CeEssentials::LocalName() const
  78     { return sLocalName; }
  79 inline Ce_id
  80 CeEssentials::Owner() const
  81     { return nOwner; }
  82 inline loc::Le_id
  83 CeEssentials::Location() const
  84     { return nLocation; }
  85
  86
  87
  88
  89 }   // namespace cpp
  90 }   // namespace ary
  91 #endif