summaryrefslogtreecommitdiffstats
path: root/libtdepim/kfileio.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:57:02 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:57:02 -0600
commit2c2fbd828ca474671bb9e03681b30b115d8d6035 (patch)
tree526a9da418f8d3d7ccf515c37048d3dfc80f2843 /libtdepim/kfileio.h
parentf0610eece3676b6fe99f42cf4ef2b19a39a5c4e8 (diff)
downloadtdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.tar.gz
tdepim-2c2fbd828ca474671bb9e03681b30b115d8d6035.zip
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'libtdepim/kfileio.h')
-rw-r--r--libtdepim/kfileio.h105
1 files changed, 105 insertions, 0 deletions
diff --git a/libtdepim/kfileio.h b/libtdepim/kfileio.h
new file mode 100644
index 000000000..15db09338
--- /dev/null
+++ b/libtdepim/kfileio.h
@@ -0,0 +1,105 @@
+/* Load / save entire (local) files with nice diagnostics dialog messages.
+ * These functions load/save the whole buffer in one i/o call, so they
+ * should be pretty efficient.
+ *
+ * Author: Stefan Taferner <taferner@kde.org>
+ * This code is under GPL.
+ */
+#ifndef kpim_kfileio_h
+#define kpim_kfileio_h
+
+#include <tqcstring.h>
+#include <tqwidget.h>
+
+#include <tdepimmacros.h>
+
+class TQString;
+
+namespace KPIM {
+
+/** Load a file. Returns a pointer to the memory-block that contains
+ * the loaded file. Returns a null string if the file could not be loaded.
+ * If withDialogs is FALSE no warning dialogs are opened if there are
+ * problems.
+ * The string returned is always zero-terminated and therefore one
+ * byte longer than the file itself.
+ * If ensureNewline is TRUE the string will always have a trailing newline.
+ */
+TQCString kFileToString(const TQString &fileName, bool ensureNewline=true,
+ bool withDialogs=true) KDE_EXPORT;
+
+// unused
+//TQByteArray kFileToBytes(const TQString &fileName, bool withDialogs=true);
+
+
+/** Save a file. If withDialogs is FALSE no warning dialogs are opened if
+ * there are problems. Returns TRUE on success and FALSE on failure.
+ * Replaces existing files without warning if askIfExists==FALSE.
+ * Makes a copy if the file exists to filename~ if createBackup==TRUE.
+ */
+bool kBytesToFile(const char* aBuffer, int len,
+ const TQString &aFileName,
+ bool aAskIfExists, bool aBackup, bool aVerbose) KDE_EXPORT;
+
+bool kCStringToFile(const TQCString& buffer, const TQString &fileName,
+ bool askIfExists=false, bool createBackup=true,
+ bool withDialogs=true) KDE_EXPORT;
+/** Does not stop at NUL */
+KDE_EXPORT bool kByteArrayToFile(const TQByteArray& buffer, const TQString &fileName,
+ bool askIfExists=false, bool createBackup=true,
+ bool withDialogs=true) KDE_EXPORT;
+
+
+ /**
+ * Checks and corrects the permissions of a file or folder, and if requested
+ * all files and folders below. It gives back a list of files which do not
+ * have the right permissions. This list can be used to show to the user.
+ *
+ * @param toCheck The file or folder of which the permissions should
+ * be checked.
+ * @param recursive Set to true, it will check the contents of a folder
+ * for the permissions recursively. If false only
+ * toCheck will be checked.
+ * @param wantItReadable Set to true, it will check for read permissions.
+ * If the read permissions are not available, there will
+ * be a attempt to correct this.
+ * @param wantItWritable Set to true, it will check for write permissions.
+ * If the write permissions are not available, there
+ * will be a attempt to correct this.
+ * @return It will return a string with all files and folders which do not
+ * have the right permissions. If empty, then all permissions are ok.
+ */
+TQString checkAndCorrectPermissionsIfPossible( const TQString &toCheck,
+ const bool recursive, const bool wantItReadable,
+ const bool wantItWritable );
+
+ /**
+ * Checks and corrects the permissions of a file or folder, and if requested
+ * all files and folders below. If the permissions are not ok, it tries to correct
+ * them. If that fails then a warning with detailled information is given.
+ *
+ * @param parent If parent is 0, then the message box becomes an
+ * application-global modal dialog box. If parent
+ * is a widget, the message box becomes modal
+ * relative to parent.
+ * @param toCheck The file or folder of which the permissions should
+ * be checked.
+ * @param recursive Set to true, it will check the contents of a folder
+ * for the permissions recursively. If false only
+ * toCheck will be checked.
+ * @param wantItReadable Set to true, it will check for read permissions.
+ * If the read permissions are not available, there will
+ * be a attempt to correct this.
+ * @param wantItWritable Set to true, it will check for write permissions.
+ * If the write permissions are not available, there
+ * will be a attempt to correct this.
+ * @return It will return true if all permissions in the end are ok. If false
+ * then the permissions are not ok and it was not possible to correct
+ * all errors.
+ */
+bool checkAndCorrectPermissionsIfPossibleWithErrorHandling( TQWidget *parent,
+ const TQString &toCheck, const bool recursive, const bool wantItReadable,
+ const bool wantItWritable );
+}
+
+#endif /*kpim_kfileio_h*/