autodoc/inc/ary/loc/loc_filebase.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: loc_filebase.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_LOC_FILEBASE_HXX
  32 #define ARY_LOC_FILEBASE_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <ary/loc/loc_le.hxx>
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 namespace ary
  42 {
  43 namespace loc
  44 {
  45
  46
  47
  48 /** Base class for classes representing source code files.
  49 */
  50 class FileBase : public LocationEntity
  51 {
  52   public:
  53     virtual                         ~FileBase() {}
  54
  55   protected:
  56                         FileBase(
  57                             const String  &     i_localName ,
  58                             Le_id               i_parentDirectory );
  59   private:
  60     // Interface LocationEntity:
  61     virtual const String &
  62                         inq_LocalName() const;
  63     virtual Le_id       inq_ParentDirectory() const;
  64
  65     // DATA
  66     String              sLocalName;
  67     Le_id               nParentDirectory;
  68 };
  69
  70
  71
  72
  73 } // namespace loc
  74 } // namespace ary
  75 #endif