Reorganize tdeioslave help handbooks, fix related protocol files and issues, update and add handbooks.

1 files changed, 82 insertions, 0 deletions

diff --git a/tdeioslave/mbox/stat.h b/tdeioslave/mbox/stat.h
new file mode 100644
index 00000000..4e2c1f02
--- /dev/null
+++ b/tdeioslave/mbox/stat.h
@@ -0,0 +1,82 @@
+/*
+ * This is a simple tdeioslave to handle mbox-files.
+ * Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+#ifndef STAT_H
+#define STAT_H
+
+#include <tdeio/global.h>
+
+class ReadMBox;
+class UrlInfo;
+
+class KURL;
+
+class TQString;
+
+/**
+ * This class is used to get the stats of a mbox-email or mbox-file.
+ * This class only uses static members.
+ */
+class Stat
+{
+public:
+	/**
+	 * Empty constructor
+	 */
+	Stat()  {}
+
+	/**
+	 * Emtpy destructor
+	 */
+	~Stat() {}
+	
+	/**
+	 * This functions gives information with a given UrlInfo.
+	 * @param info The file information
+	 * @return The information of the file as destribed in UrlInfo.
+	 */
+	static TDEIO::UDSEntry stat( const UrlInfo& info );
+	/**
+	 * This function gives information with a given ReadMBox and UrlInfo.
+	 * Through this, it is possible to ask the stats of the next message,
+	 * without reopening the mbox-file.
+	 * @param mbox The ReadMBox instance, used to search the mbox-email in.
+	 * @param info The url information.
+	 * @return The requesteds information.
+	 */
+	static TDEIO::UDSEntry stat( ReadMBox& mbox, const UrlInfo& info );
+	
+	/**
+	 * This function gets the stats of a given mbox-file in an UDSEntry.
+	 * @param info The location of the mbox-file.
+	 * @return A list of Atoms.
+	 */
+	static TDEIO::UDSEntry statDirectory( const UrlInfo& info );
+
+	/**
+	 * This function gets the stats of a geven mbox-message in a UDSEntry.
+	 * @param info The url of the mbox-message.
+	 * @return Information shipped in an UDSEntry.
+	 */
+	static TDEIO::UDSEntry statMessage( const UrlInfo& info );
+private:
+	static void addAtom( TDEIO::UDSEntry& entry, unsigned int key, const TQString& value );
+	static void addAtom( TDEIO::UDSEntry& entry, unsigned int key, const long value );
+};
+
+#endif