]> git.lyx.org Git - lyx.git/blobdiff - src/LyXVC.h
Style. Enum names and typedefs are almost always CamelCase in the LyX
[lyx.git] / src / LyXVC.h
index 86d7dcc370bf4c5c1367b81a4dd6dfba636c48fc..efe639aff97d630588e73b829aa4138032d4fdef 100644 (file)
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -65,17 +65,30 @@ public:
        void setBuffer(Buffer *);
 
        /// Register the document as an VC file.
-       void registrer();
+       bool registrer();
 
-       /// Unlock and commit changes.
-       void checkIn();
+       /// Unlock and commit changes. Returns log.
+       std::string checkIn();
        /// Does the current VC supports this operation?
-       bool checkInEnabled();
+       bool checkInEnabled() const;
 
-       /// Lock and prepare to edit document.
-       void checkOut();
+       /// Lock/update and prepare to edit document. Returns log.
+       std::string checkOut();
        /// Does the current VC supports this operation?
-       bool checkOutEnabled();
+       bool checkOutEnabled() const;
+
+       /// Synchronize the whole archive with repository
+       std::string repoUpdate();
+       /// Does the current VC supports this operation?
+       bool repoUpdateEnabled() const;
+
+       /**
+        * Toggle locking property of the edited file,
+        * i.e. whether the file uses locking mechanism.
+        */
+       std::string lockingToggle();
+       /// Does the current VC support this operation?
+       bool lockingToggleEnabled() const;
 
        /// Revert to last version
        void revert();
@@ -83,7 +96,7 @@ public:
        /// Undo last check-in.
        void undoLast();
        /// Does the current VC supports this operation?
-       bool undoLastEnabled();
+       bool undoLastEnabled() const;
 
        /**
         * Generate a log file and return the filename.
@@ -92,11 +105,16 @@ public:
         */
        const std::string getLogFile() const;
 
-       ///
+       /**
+        * We do not support this generally. In RCS/SVN file read-only flag
+        * is often connected with locking state and one has to be careful to
+        * keep things in synchro once we would allow user to toggle
+        * read-only flags.
+        */
        void toggleReadOnly();
 
        /// Is the document under administration by VCS?
-       bool inUse();
+       bool inUse() const;
 
        /// Returns the version number.
        //std::string const & version() const;