classchm_1_1chmfile.tex

It is a chm file viewer lib with source code

\label{classchm_1_1chmfile_a9}


Returns a boolean value whether given file exists inside the archive.

\hypertarget{classchm_1_1chmfile_a8}{
\index{chm::chmfile@{chm::chmfile}!file_size@{file\_\-size}}
\index{file_size@{file\_\-size}!chm::chmfile@{chm::chmfile}}
\paragraph[file\_\-size]{\setlength{\rightskip}{0pt plus 5cm}std::streamsize chm::chmfile::file\_\-size (const std::string \& {\em path}) const}\hfill}
\label{classchm_1_1chmfile_a8}


Returns the size of given file inside archive, returns 0 if file does not exist.

\hypertarget{classchm_1_1chmfile_a14}{
\index{chm::chmfile@{chm::chmfile}!get_generator@{get\_\-generator}}
\index{get_generator@{get\_\-generator}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-generator]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-generator () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a14}




Definition at line 100 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a13}{
\index{chm::chmfile@{chm::chmfile}!get_home_file@{get\_\-home\_\-file}}
\index{get_home_file@{get\_\-home\_\-file}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-home\_\-file]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-home\_\-file () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a13}




Definition at line 99 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a15}{
\index{chm::chmfile@{chm::chmfile}!get_index_file@{get\_\-index\_\-file}}
\index{get_index_file@{get\_\-index\_\-file}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-index\_\-file]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-index\_\-file () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a15}




Definition at line 101 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a17}{
\index{chm::chmfile@{chm::chmfile}!get_path@{get\_\-path}}
\index{get_path@{get\_\-path}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-path]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-path () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a17}




Definition at line 103 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a12}{
\index{chm::chmfile@{chm::chmfile}!get_title@{get\_\-title}}
\index{get_title@{get\_\-title}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-title]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-title () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a12}




Definition at line 98 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a16}{
\index{chm::chmfile@{chm::chmfile}!get_topics_file@{get\_\-topics\_\-file}}
\index{get_topics_file@{get\_\-topics\_\-file}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-topics\_\-file]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& chm::chmfile::get\_\-topics\_\-file () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a16}




Definition at line 102 of file chmxx.h.\hypertarget{classchm_1_1chmfile_a18}{
\index{chm::chmfile@{chm::chmfile}!get_topics_tree@{get\_\-topics\_\-tree}}
\index{get_topics_tree@{get\_\-topics\_\-tree}!chm::chmfile@{chm::chmfile}}
\paragraph[get\_\-topics\_\-tree]{\setlength{\rightskip}{0pt plus 5cm}const \hyperlink{structchm_1_1chm__topics__tree}{chm\_\-topics\_\-tree}$\ast$ chm::chmfile::get\_\-topics\_\-tree ()}\hfill}
\label{classchm_1_1chmfile_a18}


Gets the topics tree.

If this is called first time the tree is calculated and stored for later use. In case the chm file has no soptics tree NULL is returned. \hypertarget{classchm_1_1chmfile_a2}{
\index{chm::chmfile@{chm::chmfile}!is_open@{is\_\-open}}
\index{is_open@{is\_\-open}!chm::chmfile@{chm::chmfile}}
\paragraph[is\_\-open]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::is\_\-open ()}\hfill}
\label{classchm_1_1chmfile_a2}


Tests whether archive is valid and open.



Referenced by operator bool().\hypertarget{classchm_1_1chmfile_a11}{
\index{chm::chmfile@{chm::chmfile}!open@{open}}
\index{open@{open}!chm::chmfile@{chm::chmfile}}
\paragraph[open]{\setlength{\rightskip}{0pt plus 5cm}std::streambuf$\ast$ chm::chmfile::open (const std::string \& {\em path}, size\_\-t {\em buf\_\-size} = 1024) const}\hfill}
\label{classchm_1_1chmfile_a11}


Open given path inside the archive for reading and return a streambuf object.

Returns 0 in case file does not exist or an error happened. You're better off to using chmistream than this method. The returned object should be deleted after use. \hypertarget{classchm_1_1chmfile_a4}{
\index{chm::chmfile@{chm::chmfile}!operator bool@{operator bool}}
\index{operator bool@{operator bool}!chm::chmfile@{chm::chmfile}}
\paragraph[operator bool]{\setlength{\rightskip}{0pt plus 5cm}chm::chmfile::operator bool () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmfile_a4}


Tests whether opened archive is valid.



Definition at line 67 of file chmxx.h.

References is\_\-open().\hypertarget{classchm_1_1chmfile_a7}{
\index{chm::chmfile@{chm::chmfile}!read@{read}}
\index{read@{read}!chm::chmfile@{chm::chmfile}}
\paragraph[read]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::read (const std::string \& {\em path}, char $\ast$ {\em buf}, size\_\-t {\em buf\_\-size}) const}\hfill}
\label{classchm_1_1chmfile_a7}


Read buf\_\-size bytes from path and place into buf.

\hypertarget{classchm_1_1chmfile_a6}{
\index{chm::chmfile@{chm::chmfile}!read@{read}}
\index{read@{read}!chm::chmfile@{chm::chmfile}}
\paragraph[read]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::read (const std::string \& {\em path}, std::vector$<$ char $>$ \& {\em out}) const}\hfill}
\label{classchm_1_1chmfile_a6}


Read the entire contents of a file and store inside given vector.

The vector is resized to file size. \hypertarget{classchm_1_1chmfile_a5}{
\index{chm::chmfile@{chm::chmfile}!read@{read}}
\index{read@{read}!chm::chmfile@{chm::chmfile}}
\paragraph[read]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::read (const std::string \& {\em path}, std::ostream \& {\em out}) const}\hfill}
\label{classchm_1_1chmfile_a5}


Read the entire contents of given file and write to stream out.

\hypertarget{classchm_1_1chmfile_a10}{
\index{chm::chmfile@{chm::chmfile}!readdir@{readdir}}
\index{readdir@{readdir}!chm::chmfile@{chm::chmfile}}
\paragraph[readdir]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::readdir (const std::string \& {\em path}, std::list$<$ std::string $>$ \& {\em entries}, int {\em type} = files$|$dirs) const}\hfill}
\label{classchm_1_1chmfile_a10}


Read entries under given path and append them to the list.

Files of directory type will have '/' at the end of their names. \hypertarget{classchm_1_1chmfile_a19}{
\index{chm::chmfile@{chm::chmfile}!search_index@{search\_\-index}}
\index{search_index@{search\_\-index}!chm::chmfile@{chm::chmfile}}
\paragraph[search\_\-index]{\setlength{\rightskip}{0pt plus 5cm}bool chm::chmfile::search\_\-index (const std::string \& {\em txt}, std::list$<$ \hyperlink{structchm_1_1chm__search__match}{chm\_\-search\_\-match} $>$ \& {\em found}, bool {\em whole\_\-words} = true, bool {\em titles\_\-only} = true) const}\hfill}
\label{classchm_1_1chmfile_a19}


Search the archive for given keyword and return found entries in found.



The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{chmxx_8h}{chmxx.h}\end{CompactItemize}