From 981f8b3acf7e76f27c02f4ced80d55b424cc7497 Mon Sep 17 00:00:00 2001
From: Tannin <Tannin@Serenity>
Date: Sun, 3 Feb 2013 12:49:25 +0100
Subject: initial commit to mercurial repository. Corresponds to MO version
 0.12.6

---
 src/helper.h | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 src/helper.h

(limited to 'src/helper.h')

diff --git a/src/helper.h b/src/helper.h
new file mode 100644
index 00000000..ee49a0cd
--- /dev/null
+++ b/src/helper.h
@@ -0,0 +1,65 @@
+/*
+Copyright (C) 2012 Sebastian Herbord. All rights reserved.
+
+This file is part of Mod Organizer.
+
+Mod Organizer is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Mod Organizer 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef HELPER_H
+#define HELPER_H
+
+
+#include <QString>
+
+
+/**
+ * @brief Convenience functions to work with the external helper program.
+ * 
+ * The mo_helper program is used to make changes on the system that require administrative
+ * rights, so that ModOrganizer itself can run without special privileges
+ **/
+namespace Helper {
+
+/**
+ * @brief initialise the specified directory for use with mod organizer.
+ * 
+ * This will create all required sub-directories and give the user running ModOrganizer
+ * write-access
+ *
+ * @param moDirectory absolute path to the ModOrganizer base directory
+ * @return true on success
+ **/
+bool init(const std::wstring &moDirectory);
+
+/**
+ * @brief set or unset the current instance of ModOrganizer as the global handler for nxm links
+ *
+ * @param moDirectory absolute path to the modOrganizer base directory
+ * @param enable if true, ModOrganizer will become the handler for nxm links. If false, the nxm handler will be unset
+ * @return true on success
+ **/
+bool setNXMHandler(const std::wstring &moDirectory, bool enable);
+
+/**
+ * @brief sets the last modified time for all .bsa-files in the target directory well into the past
+ * @param moDirectory absolute path to the modOrganizer base directory
+ * @param dataPath the path taht contains the .bsa-files, usually the data directory of the game
+ **/
+bool backdateBSAs(const std::wstring &moDirectory, const std::wstring &dataPath);
+
+}
+
+
+#endif // HELPER_H
-- 
cgit v1.3.1