autodoc/inc/ary/loc/loc_root.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_root.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_LOC_PROJECT_HXX
  32 #define ARY_LOC_PROJECT_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/loc/loc_le.hxx>
  36 // USED SERVICES
  37 #include <cosv/ploc.hxx>
  38 #include <ary/loc/loc_dir.hxx>
  39
  40
  41
  42
  43 namespace ary
  44 {
  45 namespace loc
  46 {
  47
  48
  49 /** Represents a root directory for source files.
  50 */
  51 class Root : public LocationEntity
  52 {
  53   public:
  54     enum E_ClassId { class_id = 7000 };
  55
  56     explicit            Root(
  57                             const csv::ploc::Path &
  58                                                 i_rRootDirectoryPath );
  59     void                Assign_Directory(
  60                             Le_id               i_assignedDirectory );
  61     virtual             ~Root();
  62
  63     // INQUIRY
  64     const csv::ploc::Path &
  65                         Path() const;
  66     Le_id               MyDir() const;
  67
  68   private:
  69     // Interface csv::ConstProcessorClient:
  70     virtual void        do_Accept(
  71                             csv::ProcessorIfc & io_processor ) const;
  72     // Interface ary::Object:
  73     virtual ClassId     get_AryClass() const;
  74
  75     // Interface LocationEntity:
  76     virtual const String &
  77                         inq_LocalName() const;
  78     virtual Le_id       inq_ParentDirectory() const;
  79
  80     // DATA
  81     csv::ploc::Path     aPath;
  82     String              sPathAsString;
  83     Le_id               aMyDirectory;
  84 };
  85
  86
  87
  88
  89 // IMPLEMENTATION
  90 inline void
  91 Root::Assign_Directory(Le_id i_assignedDirectory)
  92 {
  93     aMyDirectory = i_assignedDirectory;
  94 }
  95
  96 inline const csv::ploc::Path &
  97 Root::Path() const
  98 {
  99     return aPath;
 100 }
 101
 102 inline Le_id
 103 Root::MyDir() const
 104 {
 105     return aMyDirectory;
 106 }
 107
 108
 109
 110
 111 } // namespace loc
 112 } // namespace ary
 113 #endif