xbmc/filesystem/DirectoryFactory.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "IDirectory.h"
  12
  13 namespace XFILE
  14 {
  15 /*!
  16  \ingroup filesystem
  17  \brief Get access to a directory of a file system.
  18
  19  The Factory can be used to create a directory object
  20  for every file system accessable. \n
  21  \n
  22  Example:
  23
  24  \verbatim
  25  std::string strShare="iso9660://";
  26
  27  IDirectory* pDir=CDirectoryFactory::Create(strShare);
  28  \endverbatim
  29  The \e pDir pointer can be used to access a directory and retrieve it's content.
  30
  31  When different types of shares have to be accessed use CVirtualDirectory.
  32  \sa IDirectory
  33  */
  34 class CDirectoryFactory
  35 {
  36 public:
  37   static IDirectory* Create(const CURL& url);
  38 };
  39 }