autodoc/source/inc/tools/filecoll.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: filecoll.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 ADC_FILECOLL_HXX
  32 #define ADC_FILECOLL_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <autodoc/filecoli.hxx>
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41
  42 class FileCollector : public autodoc::FileCollector_Ifc
  43 {
  44   public:
  45     // LIFECYCLE
  46                         FileCollector(
  47                             uintt                       i_nRoughNrOfFiles = 0 );
  48
  49     // OPERATIONS
  50     virtual uintt       AddFilesFrom(
  51                             const char *                i_sRootDir,
  52                             const char *                i_sFilter,
  53                             E_SearchMode                i_eSearchMode );
  54     virtual uintt       AddFile(
  55                             const char *                i_sFilePath );
  56     virtual void        EraseAll();
  57
  58     // INQUIRY
  59     virtual const_iterator
  60                         Begin() const;
  61     virtual const_iterator
  62                         End() const;
  63     virtual uintt       Size() const;
  64
  65   private:
  66     // DATA
  67     StringVector        aFoundFiles;
  68 };
  69
  70
  71 #endif
  72