code.vuplus.com Git - vuplus_xbmc/blob - xbmc/filesystem/DirectoryFactory.h

   1 #pragma once
   2 /*
   3  *      Copyright (C) 2005-2013 Team XBMC
   4  *      http://xbmc.org
   5  *
   6  *  This Program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This Program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with XBMC; see the file COPYING.  If not, see
  18  *  <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 #include "IDirectory.h"
  23
  24 namespace XFILE
  25 {
  26 /*!
  27  \ingroup filesystem
  28  \brief Get access to a directory of a file system.
  29
  30  The Factory can be used to create a directory object
  31  for every file system accessable. \n
  32  \n
  33  Example:
  34
  35  \verbatim
  36  CStdString strShare="iso9660://";
  37
  38  IDirectory* pDir=CDirectoryFactory::Create(strShare);
  39  \endverbatim
  40  The \e pDir pointer can be used to access a directory and retrieve it's content.
  41
  42  When different types of shares have to be accessed use CVirtualDirectory.
  43  \sa IDirectory
  44  */
  45 class CDirectoryFactory
  46 {
  47 public:
  48   static IDirectory* Create(const CStdString& strPath);
  49 };
  50 }