]> git.lyx.org Git - lyx.git/blobdiff - src/ParagraphParameters.h
Account for old versions of Pygments
[lyx.git] / src / ParagraphParameters.h
index da9ffd8fa6f7b6c1ec375f9b28fdc159773987c6..3a7569624926e59d0f8c879b75a08d3bccadc65a 100644 (file)
@@ -1,19 +1,35 @@
 // -*- C++ -*-
+/**
+ * \file ParagraphParameters.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Angus Leeming
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef PARAGRAPHPARAMETERS_H
 #define PARAGRAPHPARAMETERS_H
 
-#include "LString.h"
-#include "ShareContainer.h"
-#include "layout.h"
+#include "LayoutEnums.h"
+#include "Length.h"
+#include "Spacing.h"
 
-#include "ParameterStruct.h"
+#include "support/types.h"
+#include "support/docstring.h"
 
-#include <iosfwd>
 
-class VSpace;
+namespace lyx {
+
+class BufferView;
+class Layout;
+class Length;
+class Lexer;
+class Paragraph;
 class Spacing;
-class LyXLex;
 
 
 ///
@@ -26,14 +42,6 @@ public:
        ///
        bool sameLayout(ParagraphParameters const &) const;
        ///
-       VSpace const & spaceTop() const;
-       ///
-       void spaceTop(VSpace const &);
-       ///
-       VSpace const & spaceBottom() const;
-       ///
-       void spaceBottom(VSpace const &);
-       ///
        Spacing const & spacing() const;
        ///
        void spacing(Spacing const &);
@@ -42,28 +50,10 @@ public:
        ///
        void noindent(bool);
        ///
-       bool lineTop() const;
-       ///
-       void lineTop(bool);
-       ///
-       bool lineBottom() const;
-       ///
-       void lineBottom(bool);
-       ///
-       bool pagebreakTop() const;
-       ///
-       void pagebreakTop(bool);
-       ///
-       bool pagebreakBottom() const;
-       ///
-       void pagebreakBottom(bool);
-       ///
        LyXAlignment align() const;
        ///
        void align(LyXAlignment);
        ///
-       typedef ParameterStruct::depth_type depth_type;
-       ///
        depth_type depth() const;
        ///
        void depth(depth_type);
@@ -76,37 +66,65 @@ public:
        ///
        void appendix(bool);
        ///
-       string const & labelString() const;
+       docstring const & labelString() const;
        ///
-       void labelString(string const &);
+       void labelString(docstring const &);
        ///
-       string const & labelWidthString() const;
+       docstring const & labelWidthString() const;
        ///
-       void labelWidthString(string const &);
+       void labelWidthString(docstring const &);
        ///
-       LyXLength const & leftIndent() const;
+       Length const & leftIndent() const;
        ///
-       void leftIndent(LyXLength const &);
+       void leftIndent(Length const &);
 
+       /// read the parameters from a string
+       void read (std::string str, bool merge = true);
+       
        /// read the parameters from a lex
-       void read(LyXLex & lex);
+       void read(Lexer & lex, bool merge = true);
+       
+       /// 
+       void apply(ParagraphParameters const & params, Layout const & layout);
+       
+       // It would be nice to have a working version of this method, so that
+       // getStatus() could return information about what was possible.
+       // bool canApply(ParagraphParameters const & params, Layout const & layout)
+       //      { return true; }
 
        /// write out the parameters to a stream
        void write(std::ostream & os) const;
 
 private:
        ///
-       void set_from_struct(ParameterStruct const &);
+       Spacing spacing_;
+       ///
+       bool noindent_;
+       ///
+       bool start_of_appendix_;
+       ///
+       bool appendix_;
+       ///
+       LyXAlignment align_;
        ///
-       boost::shared_ptr<ParameterStruct> param;
+       depth_type depth_;
        ///
-       static ShareContainer<ParameterStruct> container;
+       docstring labelstring_;
+       ///
+       docstring labelwidthstring_;
+       ///
+       Length leftindent_;
 };
 
 
-inline
-ParagraphParameters::depth_type ParagraphParameters::depth() const
-{
-       return param->depth;
-}
+
+/** Generate a string \param data from \param par's ParagraphParameters.
+    The function also generates some additional info needed by the
+    Paragraph dialog.
+ */
+void params2string(Paragraph const & par, std::string & data);
+
+
+} // namespace lyx
+
 #endif