← Back to branch summary

~ubuntu-filemanager-dev/ubuntu-filemanager-app/trunk

« back to all changes in this revision

Viewing changes to src/plugin/folderlistmodel/locationitemdiriterator.h

  • Committer: Renato Araujo Oliveira Filho
  • Date: 2017-03-16 19:44:37 UTC
  • mto: (588.1.14 new-debian)
  • mto: This revision was merged to the branch mainline in revision 590.
  • Revision ID: renato.filho@canonical.com-20170316194437-e585fr1u2zjob1kd
Revert removal of folderlistmodel plugin.
Install all plugins as private component.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugin/folderlistmodel/locationitemdiriterator.h
 
1
/**************************************************************************
 
2
 *
 
3
 * Copyright 2015 Canonical Ltd.
 
4
 * Copyright 2015 Carlos J Mazieri <carlos.mazieri@gmail.com>
 
5
 *
 
6
 * This program is free software; you can redistribute it and/or modify
 
7
 * it under the terms of the GNU Lesser General Public License as published by
 
8
 * the Free Software Foundation; version 3.
 
9
 *
 
10
 * This program is distributed in the hope that it will be useful,
 
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 * GNU Lesser General Public License for more details.
 
14
 *
 
15
 * You should have received a copy of the GNU Lesser General Public License
 
16
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
17
 *
 
18
 * File: locationitemdiriterator.h
 
19
 * Date: 10/01/2015
 
20
 */
 
21
 
 
22
#ifndef LOCATIONITEMDIRITERATOR_H
 
23
#define LOCATIONITEMDIRITERATOR_H
 
24
 
 
25
#include <QDirIterator>
 
26
#include "diriteminfo.h"
 
27
 
 
28
/*!
 
29
 * \brief The LocationItemDirIterator class is an abstract similar to Qt QDirIterator
 
30
 *
 
31
 *   Different protocols supported by filemanager (different Locations) must provide a class like that.
 
32
 *
 
33
 *   The \ref LoadLater can used in the constructor to indicate to the constructor to NOT load the path/url, instead \ref load() can called later to do that.
 
34
 */
 
35
 
 
36
class LocationItemDirIterator
 
37
{
 
38
public:
 
39
   enum LoadMode
 
40
   {
 
41
     LoadOnConstructor,  //!< loads the entire directory or url in the constructor as Qt QDirIterator does
 
42
     LoadLater           //!< do NOT load the entire directory or url, \ref load() method should be responsible to do that.
 
43
   };
 
44
 
 
45
   virtual ~LocationItemDirIterator();
 
46
public:
 
47
   virtual bool         hasNext()  const = 0;
 
48
   virtual QString          next()           = 0;
 
49
 
 
50
   virtual DirItemInfo  fileInfo() const = 0;
 
51
    /*!
 
52
    * \brief fileName()
 
53
    * \return the file name for the current directory entry, without the path prepended.
 
54
    */
 
55
   virtual QString          fileName() const = 0;
 
56
 
 
57
    /*!
 
58
    * \brief filePath()
 
59
    * \return the full pathname of the current item
 
60
    */
 
61
   virtual QString          filePath() const = 0;
 
62
 
 
63
    /*!
 
64
    * \brief path()
 
65
    * \return  the base directory of the iterator path (not the current item)
 
66
    */
 
67
   virtual QString          path()     const;
 
68
 
 
69
   /*!
 
70
    * \brief load()  responsible to load the entire directory or url when \ref LoadLater is passed to the constructor
 
71
    */
 
72
   virtual void         load() ;
 
73
 
 
74
   QDir::Filters        filters()  const;
 
75
   QDirIterator::IteratorFlags flags() const;
 
76
 
 
77
protected:
 
78
   LocationItemDirIterator(const QString & path,
 
79
                           QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags,
 
80
                           LocationItemDirIterator::LoadMode loadmode = LocationItemDirIterator::LoadOnConstructor);
 
81
 
 
82
   LocationItemDirIterator(const QString & path,
 
83
                           QDir::Filters filters,
 
84
                           QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags,
 
85
                           LocationItemDirIterator::LoadMode loadmode = LocationItemDirIterator::LoadOnConstructor);
 
86
 
 
87
   LocationItemDirIterator(const QString & path,
 
88
                           const QStringList & nameFilters,
 
89
                           QDir::Filters filters = QDir::NoFilter,
 
90
                           QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags,
 
91
                           LocationItemDirIterator::LoadMode loadmode = LocationItemDirIterator::LoadOnConstructor);
 
92
 
 
93
protected:
 
94
   QString                     m_path;
 
95
   QStringList                 m_nameFilters;
 
96
   QDir::Filters               m_filters;
 
97
   QDirIterator::IteratorFlags m_flags;
 
98
};
 
99
 
 
100
 
 
101
#endif // LOCATIONITEMDIRITERATOR_H