[1050] | 1 | \section{QuaZipDir Class Reference}
|
---|
| 2 | \label{classQuaZipDir}\index{QuaZipDir@{QuaZipDir}}
|
---|
| 3 |
|
---|
| 4 |
|
---|
| 5 | Provides ZIP archive navigation.
|
---|
| 6 |
|
---|
| 7 |
|
---|
| 8 |
|
---|
| 9 |
|
---|
| 10 | {\ttfamily \#include $<$quazipdir.h$>$}
|
---|
| 11 |
|
---|
| 12 |
|
---|
| 13 |
|
---|
| 14 | Collaboration diagram for QuaZipDir:
|
---|
| 15 | \nopagebreak
|
---|
| 16 | \begin{figure}[H]
|
---|
| 17 | \begin{center}
|
---|
| 18 | \leavevmode
|
---|
| 19 | \includegraphics[width=240pt]{classQuaZipDir__coll__graph}
|
---|
| 20 | \end{center}
|
---|
| 21 | \end{figure}
|
---|
| 22 | \subsection*{Public Member Functions}
|
---|
| 23 | \begin{DoxyCompactItemize}
|
---|
| 24 | \item
|
---|
| 25 | {\bf QuaZipDir} (const {\bf QuaZipDir} \&that)\label{classQuaZipDir_a6c9cc8b74c52d3fe997b753370566690}
|
---|
| 26 |
|
---|
| 27 | \begin{DoxyCompactList}\small\item\em The copy constructor. \end{DoxyCompactList}\item
|
---|
| 28 | {\bf QuaZipDir} ({\bf QuaZip} $\ast$zip, const {\bf QString} \&dir={\bf QString}())
|
---|
| 29 | \begin{DoxyCompactList}\small\item\em Constructs a \doxyref{QuaZipDir}{p.}{classQuaZipDir} instance pointing to the specified directory. \end{DoxyCompactList}\item
|
---|
| 30 | {\bf $\sim$QuaZipDir} ()\label{classQuaZipDir_ae95d60e2c23e611723371bf8fff2b095}
|
---|
| 31 |
|
---|
| 32 | \begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
---|
| 33 | bool {\bf operator==} (const {\bf QuaZipDir} \&that)\label{classQuaZipDir_a4a2e07484c7159a3f469922ba2383547}
|
---|
| 34 |
|
---|
| 35 | \begin{DoxyCompactList}\small\item\em The assignment operator. \end{DoxyCompactList}\item
|
---|
| 36 | bool {\bf operator!=} (const {\bf QuaZipDir} \&that)
|
---|
| 37 | \begin{DoxyCompactList}\small\item\em operator!= \end{DoxyCompactList}\item
|
---|
| 38 | {\bf QuaZipDir} \& {\bf operator=} (const {\bf QuaZipDir} \&that)
|
---|
| 39 | \begin{DoxyCompactList}\small\item\em operator== \end{DoxyCompactList}\item
|
---|
| 40 | {\bf QString} {\bf operator[$\,$]} (int pos) const \label{classQuaZipDir_a9e37ef5318c44a4575c58d66110e535a}
|
---|
| 41 |
|
---|
| 42 | \begin{DoxyCompactList}\small\item\em Returns the name of the entry at the specified position. \end{DoxyCompactList}\item
|
---|
| 43 | {\bf QuaZip::CaseSensitivity} {\bf caseSensitivity} () const \label{classQuaZipDir_ad7ab403a8d36a3b6149da86ea37178f8}
|
---|
| 44 |
|
---|
| 45 | \begin{DoxyCompactList}\small\item\em Returns the current case sensitivity mode. \end{DoxyCompactList}\item
|
---|
| 46 | bool {\bf cd} (const {\bf QString} \&dirName)
|
---|
| 47 | \begin{DoxyCompactList}\small\item\em Changes the 'current' directory. \end{DoxyCompactList}\item
|
---|
| 48 | bool {\bf cdUp} ()\label{classQuaZipDir_a62306db3f4c0866930fa35c7348b84b3}
|
---|
| 49 |
|
---|
| 50 | \begin{DoxyCompactList}\small\item\em Goes up. \end{DoxyCompactList}\item
|
---|
| 51 | uint {\bf count} () const \label{classQuaZipDir_aa3f14665e3991351f4ef94ab8e0ab29d}
|
---|
| 52 |
|
---|
| 53 | \begin{DoxyCompactList}\small\item\em Returns the number of entries in the directory. \end{DoxyCompactList}\item
|
---|
| 54 | {\bf QString} {\bf dirName} () const
|
---|
| 55 | \begin{DoxyCompactList}\small\item\em Returns the current directory name. \end{DoxyCompactList}\item
|
---|
| 56 | {\bf QList}$<$ {\bf QuaZipFileInfo} $>$ {\bf entryInfoList} (const {\bf QStringList} \&nameFilters, {\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 57 | \begin{DoxyCompactList}\small\item\em Returns the list of the entries in the directory. \end{DoxyCompactList}\item
|
---|
| 58 | {\bf QList}$<$ {\bf QuaZipFileInfo} $>$ {\bf entryInfoList} ({\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 59 | \begin{DoxyCompactList}\small\item\em Returns the list of the entries in the directory. \end{DoxyCompactList}\item
|
---|
| 60 | {\bf QList}$<$ {\bf QuaZipFileInfo64} $>$ {\bf entryInfoList64} (const {\bf QStringList} \&nameFilters, {\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 61 | \begin{DoxyCompactList}\small\item\em Returns the list of the entries in the directory with zip64 support. \end{DoxyCompactList}\item
|
---|
| 62 | {\bf QList}$<$ {\bf QuaZipFileInfo64} $>$ {\bf entryInfoList64} ({\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 63 | \begin{DoxyCompactList}\small\item\em Returns the list of the entries in the directory with zip64 support. \end{DoxyCompactList}\item
|
---|
| 64 | {\bf QStringList} {\bf entryList} (const {\bf QStringList} \&nameFilters, {\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 65 | \begin{DoxyCompactList}\small\item\em Returns the list of the entry names in the directory. \end{DoxyCompactList}\item
|
---|
| 66 | {\bf QStringList} {\bf entryList} ({\bf QDir::Filters} filters=QDir::NoFilter, {\bf QDir::SortFlags} sort=QDir::NoSort) const
|
---|
| 67 | \begin{DoxyCompactList}\small\item\em Returns the list of the entry names in the directory. \end{DoxyCompactList}\item
|
---|
| 68 | bool {\bf exists} (const {\bf QString} \&fileName) const
|
---|
| 69 | \begin{DoxyCompactList}\small\item\em Returns {\ttfamily true} if the entry with the specified name exists. \end{DoxyCompactList}\item
|
---|
| 70 | bool {\bf exists} () const \label{classQuaZipDir_a22c8f63ce874f5c0e958ae5f42e6d004}
|
---|
| 71 |
|
---|
| 72 | \begin{DoxyCompactList}\small\item\em Return {\ttfamily true} if the directory pointed by this \doxyref{QuaZipDir}{p.}{classQuaZipDir} exists. \end{DoxyCompactList}\item
|
---|
| 73 | {\bf QString} {\bf filePath} (const {\bf QString} \&fileName) const
|
---|
| 74 | \begin{DoxyCompactList}\small\item\em Returns the full path to the specified file. \end{DoxyCompactList}\item
|
---|
| 75 | {\bf QDir::Filters} {\bf filter} ()\label{classQuaZipDir_abeee1810c7c1c1af93364081dbf70d38}
|
---|
| 76 |
|
---|
| 77 | \begin{DoxyCompactList}\small\item\em Returns the default filter. \end{DoxyCompactList}\item
|
---|
| 78 | bool {\bf isRoot} () const
|
---|
| 79 | \begin{DoxyCompactList}\small\item\em Returns if the \doxyref{QuaZipDir}{p.}{classQuaZipDir} points to the root of the archive. \end{DoxyCompactList}\item
|
---|
| 80 | {\bf QStringList} {\bf nameFilters} () const \label{classQuaZipDir_a00f18e23abb8cac04f975e7f31553f2e}
|
---|
| 81 |
|
---|
| 82 | \begin{DoxyCompactList}\small\item\em Return the default name filter. \end{DoxyCompactList}\item
|
---|
| 83 | {\bf QString} {\bf path} () const
|
---|
| 84 | \begin{DoxyCompactList}\small\item\em Returns the path to the current dir. \end{DoxyCompactList}\item
|
---|
| 85 | {\bf QString} {\bf relativeFilePath} (const {\bf QString} \&fileName) const
|
---|
| 86 | \begin{DoxyCompactList}\small\item\em Returns the path to the specified file relative to the current dir. \end{DoxyCompactList}\item
|
---|
| 87 | void {\bf setCaseSensitivity} ({\bf QuaZip::CaseSensitivity} caseSensitivity)\label{classQuaZipDir_ad53c720975bb0c49a823355f7d518793}
|
---|
| 88 |
|
---|
| 89 | \begin{DoxyCompactList}\small\item\em Sets the default case sensitivity mode. \end{DoxyCompactList}\item
|
---|
| 90 | void {\bf setFilter} ({\bf QDir::Filters} filters)\label{classQuaZipDir_a779a43641f0f3802678e39c9acd1fddb}
|
---|
| 91 |
|
---|
| 92 | \begin{DoxyCompactList}\small\item\em Sets the default filter. \end{DoxyCompactList}\item
|
---|
| 93 | void {\bf setNameFilters} (const {\bf QStringList} \&nameFilters)\label{classQuaZipDir_abcf208bfd6136e14f36725ae79dce2be}
|
---|
| 94 |
|
---|
| 95 | \begin{DoxyCompactList}\small\item\em Sets the default name filter. \end{DoxyCompactList}\item
|
---|
| 96 | void {\bf setPath} (const {\bf QString} \&path)
|
---|
| 97 | \begin{DoxyCompactList}\small\item\em Goes to the specified path. \end{DoxyCompactList}\item
|
---|
| 98 | void {\bf setSorting} ({\bf QDir::SortFlags} sort)\label{classQuaZipDir_ae43e9d717e3c4b1c0d4790cf558e7451}
|
---|
| 99 |
|
---|
| 100 | \begin{DoxyCompactList}\small\item\em Sets the default sorting mode. \end{DoxyCompactList}\item
|
---|
| 101 | {\bf QDir::SortFlags} {\bf sorting} () const \label{classQuaZipDir_a4000523c961ab9e0cad08641ff10e3fa}
|
---|
| 102 |
|
---|
| 103 | \begin{DoxyCompactList}\small\item\em Returns the default sorting mode. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
---|
| 104 |
|
---|
| 105 |
|
---|
| 106 | \subsection{Detailed Description}
|
---|
| 107 | Provides ZIP archive navigation.
|
---|
| 108 |
|
---|
| 109 | This class is modelled after {\bf QDir}, and is designed to provide similar features for ZIP archives.
|
---|
| 110 |
|
---|
| 111 | The only significant difference from {\bf QDir} is that the root path is not '/', but an empty string since that's how the file paths are stored in the archive. However, \doxyref{QuaZipDir}{p.}{classQuaZipDir} understands the paths starting with '/'. It is important in a few places:
|
---|
| 112 |
|
---|
| 113 |
|
---|
| 114 | \begin{DoxyItemize}
|
---|
| 115 | \item In the \doxyref{cd()}{p.}{classQuaZipDir_aa829afc0243f1d307302f1167edecc7b} function.
|
---|
| 116 | \item In the constructor.
|
---|
| 117 | \item In the \doxyref{exists()}{p.}{classQuaZipDir_aacb488fec6e951ac80e5d473534fee97} function.
|
---|
| 118 | \item In the relativePath() function.
|
---|
| 119 | \end{DoxyItemize}
|
---|
| 120 |
|
---|
| 121 | Note that since ZIP uses '/' on all platforms, the '$\backslash$' separator is not supported.
|
---|
| 122 |
|
---|
| 123 | \subsection{Constructor \& Destructor Documentation}
|
---|
| 124 | \index{QuaZipDir@{QuaZipDir}!QuaZipDir@{QuaZipDir}}
|
---|
| 125 | \index{QuaZipDir@{QuaZipDir}!QuaZipDir@{QuaZipDir}}
|
---|
| 126 | \subsubsection[{QuaZipDir}]{\setlength{\rightskip}{0pt plus 5cm}QuaZipDir::QuaZipDir (
|
---|
| 127 | \begin{DoxyParamCaption}
|
---|
| 128 | \item[{{\bf QuaZip} $\ast$}]{zip, }
|
---|
| 129 | \item[{const {\bf QString} \&}]{dir = {\ttfamily {\bf QString}()}}
|
---|
| 130 | \end{DoxyParamCaption}
|
---|
| 131 | )}\label{classQuaZipDir_a19e5e3a54f322ce03e7f7606a87a2ba1}
|
---|
| 132 |
|
---|
| 133 |
|
---|
| 134 | Constructs a \doxyref{QuaZipDir}{p.}{classQuaZipDir} instance pointing to the specified directory.
|
---|
| 135 |
|
---|
| 136 | If {\itshape dir\/} is not specified, points to the root of the archive. The same happens if the {\itshape dir\/} is "/".
|
---|
| 137 |
|
---|
| 138 | \subsection{Member Function Documentation}
|
---|
| 139 | \index{QuaZipDir@{QuaZipDir}!operator!=@{operator!=}}
|
---|
| 140 | \index{operator!=@{operator!=}!QuaZipDir@{QuaZipDir}}
|
---|
| 141 | \subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}bool QuaZipDir::operator!= (
|
---|
| 142 | \begin{DoxyParamCaption}
|
---|
| 143 | \item[{const {\bf QuaZipDir} \&}]{that}
|
---|
| 144 | \end{DoxyParamCaption}
|
---|
| 145 | )\hspace{0.3cm}{\ttfamily [inline]}}\label{classQuaZipDir_a6e60d858d05774c958215ee7741eceed}
|
---|
| 146 |
|
---|
| 147 |
|
---|
| 148 | operator!=
|
---|
| 149 |
|
---|
| 150 | \begin{DoxyReturn}{Returns}
|
---|
| 151 | {\ttfamily true} if either this and {\itshape that\/} use different \doxyref{QuaZip}{p.}{classQuaZip} instances or if they point to different directories.
|
---|
| 152 | \end{DoxyReturn}
|
---|
| 153 | \index{QuaZipDir@{QuaZipDir}!operator=@{operator=}}
|
---|
| 154 | \index{operator=@{operator=}!QuaZipDir@{QuaZipDir}}
|
---|
| 155 | \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QuaZipDir} \& QuaZipDir::operator= (
|
---|
| 156 | \begin{DoxyParamCaption}
|
---|
| 157 | \item[{const {\bf QuaZipDir} \&}]{that}
|
---|
| 158 | \end{DoxyParamCaption}
|
---|
| 159 | )}\label{classQuaZipDir_aa603c69be0c1597add5951b19f8bc961}
|
---|
| 160 |
|
---|
| 161 |
|
---|
| 162 | operator==
|
---|
| 163 |
|
---|
| 164 | \begin{DoxyReturn}{Returns}
|
---|
| 165 | {\ttfamily true} if both this and {\itshape that\/} use the same \doxyref{QuaZip}{p.}{classQuaZip} instance and point to the same directory.
|
---|
| 166 | \end{DoxyReturn}
|
---|
| 167 | \index{QuaZipDir@{QuaZipDir}!cd@{cd}}
|
---|
| 168 | \index{cd@{cd}!QuaZipDir@{QuaZipDir}}
|
---|
| 169 | \subsubsection[{cd}]{\setlength{\rightskip}{0pt plus 5cm}bool QuaZipDir::cd (
|
---|
| 170 | \begin{DoxyParamCaption}
|
---|
| 171 | \item[{const {\bf QString} \&}]{dirName}
|
---|
| 172 | \end{DoxyParamCaption}
|
---|
| 173 | )}\label{classQuaZipDir_aa829afc0243f1d307302f1167edecc7b}
|
---|
| 174 |
|
---|
| 175 |
|
---|
| 176 | Changes the 'current' directory.
|
---|
| 177 |
|
---|
| 178 | If the path starts with '/', it is interpreted as an absolute path from the root of the archive. Otherwise, it is interpreted as a path relative to the current directory as was set by the previous \doxyref{cd()}{p.}{classQuaZipDir_aa829afc0243f1d307302f1167edecc7b} or the constructor.
|
---|
| 179 |
|
---|
| 180 | Note that the subsequent \doxyref{path()}{p.}{classQuaZipDir_a68ac82ad605c0b10f9ee1a2d6d474f52} call will not return a path starting with '/' in all cases.
|
---|
| 181 |
|
---|
| 182 | References cd(), QString::chop(), QList::constBegin(), QByteArray::constData(), QString::contains(), dirName(), QList::end(), QString::endsWith(), exists(), isRoot(), path(), QString::split(), QString::startsWith(), and QString::toUtf8().
|
---|
| 183 |
|
---|
| 184 |
|
---|
| 185 |
|
---|
| 186 | Referenced by cd(), and cdUp().
|
---|
| 187 |
|
---|
| 188 | \index{QuaZipDir@{QuaZipDir}!dirName@{dirName}}
|
---|
| 189 | \index{dirName@{dirName}!QuaZipDir@{QuaZipDir}}
|
---|
| 190 | \subsubsection[{dirName}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} QuaZipDir::dirName (
|
---|
| 191 | \begin{DoxyParamCaption}
|
---|
| 192 | {}
|
---|
| 193 | \end{DoxyParamCaption}
|
---|
| 194 | ) const}\label{classQuaZipDir_afd2f76410f7728a7166b7598926fbf96}
|
---|
| 195 |
|
---|
| 196 |
|
---|
| 197 | Returns the current directory name.
|
---|
| 198 |
|
---|
| 199 | The name doesn't include the path.
|
---|
| 200 |
|
---|
| 201 | References QDir::dirName().
|
---|
| 202 |
|
---|
| 203 |
|
---|
| 204 |
|
---|
| 205 | Referenced by cd().
|
---|
| 206 |
|
---|
| 207 | \index{QuaZipDir@{QuaZipDir}!entryInfoList@{entryInfoList}}
|
---|
| 208 | \index{entryInfoList@{entryInfoList}!QuaZipDir@{QuaZipDir}}
|
---|
| 209 | \subsubsection[{entryInfoList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QList}$<$ {\bf QuaZipFileInfo} $>$ QuaZipDir::entryInfoList (
|
---|
| 210 | \begin{DoxyParamCaption}
|
---|
| 211 | \item[{const {\bf QStringList} \&}]{nameFilters, }
|
---|
| 212 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 213 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 214 | \end{DoxyParamCaption}
|
---|
| 215 | ) const}\label{classQuaZipDir_aef966735a146fc10c9527c236aa89261}
|
---|
| 216 |
|
---|
| 217 |
|
---|
| 218 | Returns the list of the entries in the directory.
|
---|
| 219 |
|
---|
| 220 |
|
---|
| 221 | \begin{DoxyParams}{Parameters}
|
---|
| 222 | {\em nameFilters} & The list of file patterns to list, uses the same syntax as {\bf QDir}. \\
|
---|
| 223 | \hline
|
---|
| 224 | {\em filters} & The entry type filters, only Files and Dirs are accepted. \\
|
---|
| 225 | \hline
|
---|
| 226 | {\em sort} & Sorting mode.\\
|
---|
| 227 | \hline
|
---|
| 228 | \end{DoxyParams}
|
---|
| 229 |
|
---|
| 230 |
|
---|
| 231 | Referenced by entryInfoList().
|
---|
| 232 |
|
---|
| 233 | \index{QuaZipDir@{QuaZipDir}!entryInfoList@{entryInfoList}}
|
---|
| 234 | \index{entryInfoList@{entryInfoList}!QuaZipDir@{QuaZipDir}}
|
---|
| 235 | \subsubsection[{entryInfoList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QList}$<$ {\bf QuaZipFileInfo} $>$ QuaZipDir::entryInfoList (
|
---|
| 236 | \begin{DoxyParamCaption}
|
---|
| 237 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 238 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 239 | \end{DoxyParamCaption}
|
---|
| 240 | ) const}\label{classQuaZipDir_abec530f15597ddf8c8d1f340a333f7aa}
|
---|
| 241 |
|
---|
| 242 |
|
---|
| 243 | Returns the list of the entries in the directory.
|
---|
| 244 |
|
---|
| 245 | This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. The same as entryInfoList(QStringList(), filters, sort).
|
---|
| 246 |
|
---|
| 247 | References entryInfoList().
|
---|
| 248 |
|
---|
| 249 | \index{QuaZipDir@{QuaZipDir}!entryInfoList64@{entryInfoList64}}
|
---|
| 250 | \index{entryInfoList64@{entryInfoList64}!QuaZipDir@{QuaZipDir}}
|
---|
| 251 | \subsubsection[{entryInfoList64}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QList}$<$ {\bf QuaZipFileInfo64} $>$ QuaZipDir::entryInfoList64 (
|
---|
| 252 | \begin{DoxyParamCaption}
|
---|
| 253 | \item[{const {\bf QStringList} \&}]{nameFilters, }
|
---|
| 254 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 255 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 256 | \end{DoxyParamCaption}
|
---|
| 257 | ) const}\label{classQuaZipDir_ae2b5a4b251db7aeb165c6656da0e3431}
|
---|
| 258 |
|
---|
| 259 |
|
---|
| 260 | Returns the list of the entries in the directory with zip64 support.
|
---|
| 261 |
|
---|
| 262 |
|
---|
| 263 | \begin{DoxyParams}{Parameters}
|
---|
| 264 | {\em nameFilters} & The list of file patterns to list, uses the same syntax as {\bf QDir}. \\
|
---|
| 265 | \hline
|
---|
| 266 | {\em filters} & The entry type filters, only Files and Dirs are accepted. \\
|
---|
| 267 | \hline
|
---|
| 268 | {\em sort} & Sorting mode. \\
|
---|
| 269 | \hline
|
---|
| 270 | \end{DoxyParams}
|
---|
| 271 |
|
---|
| 272 |
|
---|
| 273 | Referenced by entryInfoList64().
|
---|
| 274 |
|
---|
| 275 | \index{QuaZipDir@{QuaZipDir}!entryInfoList64@{entryInfoList64}}
|
---|
| 276 | \index{entryInfoList64@{entryInfoList64}!QuaZipDir@{QuaZipDir}}
|
---|
| 277 | \subsubsection[{entryInfoList64}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QList}$<$ {\bf QuaZipFileInfo64} $>$ QuaZipDir::entryInfoList64 (
|
---|
| 278 | \begin{DoxyParamCaption}
|
---|
| 279 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 280 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 281 | \end{DoxyParamCaption}
|
---|
| 282 | ) const}\label{classQuaZipDir_a8c38ec214c300049685cbf71486636d5}
|
---|
| 283 |
|
---|
| 284 |
|
---|
| 285 | Returns the list of the entries in the directory with zip64 support.
|
---|
| 286 |
|
---|
| 287 | This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. The same as entryInfoList64(QStringList(), filters, sort).
|
---|
| 288 |
|
---|
| 289 | References entryInfoList64().
|
---|
| 290 |
|
---|
| 291 | \index{QuaZipDir@{QuaZipDir}!entryList@{entryList}}
|
---|
| 292 | \index{entryList@{entryList}!QuaZipDir@{QuaZipDir}}
|
---|
| 293 | \subsubsection[{entryList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QStringList} QuaZipDir::entryList (
|
---|
| 294 | \begin{DoxyParamCaption}
|
---|
| 295 | \item[{const {\bf QStringList} \&}]{nameFilters, }
|
---|
| 296 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 297 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 298 | \end{DoxyParamCaption}
|
---|
| 299 | ) const}\label{classQuaZipDir_a4a32faa77c4120cd3c6db4b683fa16d9}
|
---|
| 300 |
|
---|
| 301 |
|
---|
| 302 | Returns the list of the entry names in the directory.
|
---|
| 303 |
|
---|
| 304 | The same as entryInfoList(nameFilters, filters, sort), but only returns entry names.
|
---|
| 305 |
|
---|
| 306 | Referenced by count(), entryList(), exists(), and operator[$\,$]().
|
---|
| 307 |
|
---|
| 308 | \index{QuaZipDir@{QuaZipDir}!entryList@{entryList}}
|
---|
| 309 | \index{entryList@{entryList}!QuaZipDir@{QuaZipDir}}
|
---|
| 310 | \subsubsection[{entryList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QStringList} QuaZipDir::entryList (
|
---|
| 311 | \begin{DoxyParamCaption}
|
---|
| 312 | \item[{{\bf QDir::Filters}}]{filters = {\ttfamily QDir::NoFilter}, }
|
---|
| 313 | \item[{{\bf QDir::SortFlags}}]{sort = {\ttfamily QDir::NoSort}}
|
---|
| 314 | \end{DoxyParamCaption}
|
---|
| 315 | ) const}\label{classQuaZipDir_ab20e9d3de675b74fcacc98accbc1d766}
|
---|
| 316 |
|
---|
| 317 |
|
---|
| 318 | Returns the list of the entry names in the directory.
|
---|
| 319 |
|
---|
| 320 | This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. The same as entryList(QStringList(), filters, sort).
|
---|
| 321 |
|
---|
| 322 | References entryList().
|
---|
| 323 |
|
---|
| 324 | \index{QuaZipDir@{QuaZipDir}!exists@{exists}}
|
---|
| 325 | \index{exists@{exists}!QuaZipDir@{QuaZipDir}}
|
---|
| 326 | \subsubsection[{exists}]{\setlength{\rightskip}{0pt plus 5cm}bool QuaZipDir::exists (
|
---|
| 327 | \begin{DoxyParamCaption}
|
---|
| 328 | \item[{const {\bf QString} \&}]{fileName}
|
---|
| 329 | \end{DoxyParamCaption}
|
---|
| 330 | ) const}\label{classQuaZipDir_aacb488fec6e951ac80e5d473534fee97}
|
---|
| 331 |
|
---|
| 332 |
|
---|
| 333 | Returns {\ttfamily true} if the entry with the specified name exists.
|
---|
| 334 |
|
---|
| 335 | The ".." is considered to exist if the current directory is not root. The "." and "/" are considered to always exist. Paths starting with "/" are relative to the archive root, other paths are relative to the current dir.
|
---|
| 336 |
|
---|
| 337 | References QString::chop(), QList::constBegin(), QByteArray::constData(), QList::constEnd(), QStringList::contains(), QString::contains(), QuaZip::convertCaseSensitivity(), QString::endsWith(), entryList(), QFileInfo::fileName(), filePath(), QString::isEmpty(), isRoot(), QFileInfo::path(), and QString::toUtf8().
|
---|
| 338 |
|
---|
| 339 | \index{QuaZipDir@{QuaZipDir}!filePath@{filePath}}
|
---|
| 340 | \index{filePath@{filePath}!QuaZipDir@{QuaZipDir}}
|
---|
| 341 | \subsubsection[{filePath}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} QuaZipDir::filePath (
|
---|
| 342 | \begin{DoxyParamCaption}
|
---|
| 343 | \item[{const {\bf QString} \&}]{fileName}
|
---|
| 344 | \end{DoxyParamCaption}
|
---|
| 345 | ) const}\label{classQuaZipDir_ae8b576a150f8d62c902067603cbc97ae}
|
---|
| 346 |
|
---|
| 347 |
|
---|
| 348 | Returns the full path to the specified file.
|
---|
| 349 |
|
---|
| 350 | Doesn't check if the file actually exists.
|
---|
| 351 |
|
---|
| 352 | References QDir::filePath().
|
---|
| 353 |
|
---|
| 354 |
|
---|
| 355 |
|
---|
| 356 | Referenced by exists().
|
---|
| 357 |
|
---|
| 358 | \index{QuaZipDir@{QuaZipDir}!isRoot@{isRoot}}
|
---|
| 359 | \index{isRoot@{isRoot}!QuaZipDir@{QuaZipDir}}
|
---|
| 360 | \subsubsection[{isRoot}]{\setlength{\rightskip}{0pt plus 5cm}bool QuaZipDir::isRoot (
|
---|
| 361 | \begin{DoxyParamCaption}
|
---|
| 362 | {}
|
---|
| 363 | \end{DoxyParamCaption}
|
---|
| 364 | ) const}\label{classQuaZipDir_a598fdf23f1b37e1876476e5969040a32}
|
---|
| 365 |
|
---|
| 366 |
|
---|
| 367 | Returns if the \doxyref{QuaZipDir}{p.}{classQuaZipDir} points to the root of the archive.
|
---|
| 368 |
|
---|
| 369 | Not that the root path is the empty string, not '/'.
|
---|
| 370 |
|
---|
| 371 | Referenced by cd(), and exists().
|
---|
| 372 |
|
---|
| 373 | \index{QuaZipDir@{QuaZipDir}!path@{path}}
|
---|
| 374 | \index{path@{path}!QuaZipDir@{QuaZipDir}}
|
---|
| 375 | \subsubsection[{path}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} QuaZipDir::path (
|
---|
| 376 | \begin{DoxyParamCaption}
|
---|
| 377 | {}
|
---|
| 378 | \end{DoxyParamCaption}
|
---|
| 379 | ) const}\label{classQuaZipDir_a68ac82ad605c0b10f9ee1a2d6d474f52}
|
---|
| 380 |
|
---|
| 381 |
|
---|
| 382 | Returns the path to the current dir.
|
---|
| 383 |
|
---|
| 384 | The path never starts with '/', and the root path is an empty string.
|
---|
| 385 |
|
---|
| 386 | Referenced by cd(), and setPath().
|
---|
| 387 |
|
---|
| 388 | \index{QuaZipDir@{QuaZipDir}!relativeFilePath@{relativeFilePath}}
|
---|
| 389 | \index{relativeFilePath@{relativeFilePath}!QuaZipDir@{QuaZipDir}}
|
---|
| 390 | \subsubsection[{relativeFilePath}]{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} QuaZipDir::relativeFilePath (
|
---|
| 391 | \begin{DoxyParamCaption}
|
---|
| 392 | \item[{const {\bf QString} \&}]{fileName}
|
---|
| 393 | \end{DoxyParamCaption}
|
---|
| 394 | ) const}\label{classQuaZipDir_a2ae89c2b85786a0168656fc7a3faaf01}
|
---|
| 395 |
|
---|
| 396 |
|
---|
| 397 | Returns the path to the specified file relative to the current dir.
|
---|
| 398 |
|
---|
| 399 | This function is mostly useless, provided only for the sake of completeness.
|
---|
| 400 |
|
---|
| 401 |
|
---|
| 402 | \begin{DoxyParams}{Parameters}
|
---|
| 403 | {\em fileName} & The path to the file, should start with "/" if relative to the archive root. \\
|
---|
| 404 | \hline
|
---|
| 405 | \end{DoxyParams}
|
---|
| 406 | \begin{DoxyReturn}{Returns}
|
---|
| 407 | Path relative to the current dir.
|
---|
| 408 | \end{DoxyReturn}
|
---|
| 409 |
|
---|
| 410 |
|
---|
| 411 | References QDir::relativeFilePath().
|
---|
| 412 |
|
---|
| 413 | \index{QuaZipDir@{QuaZipDir}!setPath@{setPath}}
|
---|
| 414 | \index{setPath@{setPath}!QuaZipDir@{QuaZipDir}}
|
---|
| 415 | \subsubsection[{setPath}]{\setlength{\rightskip}{0pt plus 5cm}void QuaZipDir::setPath (
|
---|
| 416 | \begin{DoxyParamCaption}
|
---|
| 417 | \item[{const {\bf QString} \&}]{path}
|
---|
| 418 | \end{DoxyParamCaption}
|
---|
| 419 | )}\label{classQuaZipDir_ae82d06e43856414c30583205d337c111}
|
---|
| 420 |
|
---|
| 421 |
|
---|
| 422 | Goes to the specified path.
|
---|
| 423 |
|
---|
| 424 | The difference from \doxyref{cd()}{p.}{classQuaZipDir_aa829afc0243f1d307302f1167edecc7b} is that this function never checks if the path actually exists and doesn't use relative paths, so it's possible to go to the root directory with setPath("").
|
---|
| 425 |
|
---|
| 426 | Note that this function still chops the trailing and/or leading '/' and treats a single '/' as the root path (\doxyref{path()}{p.}{classQuaZipDir_a68ac82ad605c0b10f9ee1a2d6d474f52} will still return an empty string).
|
---|
| 427 |
|
---|
| 428 | References QString::chop(), QString::endsWith(), QString::mid(), path(), and QString::startsWith().
|
---|
| 429 |
|
---|
| 430 |
|
---|
| 431 |
|
---|
| 432 | The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
|
---|
| 433 | \item
|
---|
| 434 | quazip/quazipdir.h\item
|
---|
| 435 | quazip/quazipdir.cpp\end{DoxyCompactItemize}
|
---|