// -*- 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
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "LayoutEnums.h"
+#include "Spacing.h"
+
+#include "support/types.h"
+#include "support/strfwd.h"
+#include "support/Length.h"
-#include "ShareContainer.h"
-#include "LString.h"
-#include "layout.h"
-// Not yet... lyx 1.3.x or so
-#define NO_PEXTRA_REALLY 1
+namespace lyx {
-#include "ParameterStruct.h"
+class Layout;
+class Paragraph;
-class VSpace;
-class Spacing;
+namespace support { class Lexer; }
///
///
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 &);
///
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);
///
void appendix(bool);
///
- string const & labelString() const;
- ///
- void labelString(string const &);
- ///
- string const & labelWidthString() const;
+ docstring const & labelString() const;
///
- void labelWidthString(string const &);
+ void labelString(docstring const &);
///
- LyXLength const & leftIndent() const;
+ docstring const & labelWidthString() const;
///
- void leftIndent(LyXLength const &);
+ void labelWidthString(docstring const &);
///
-#ifndef NO_PEXTRA_REALLY
+ Length const & leftIndent() const;
///
- int pextraType() const;
- ///
- void pextraType(int);
- ///
- string const & pextraWidth() const;
- ///
- void pextraWidth(string const &);
- ///
- string const & pextraWidthp() const;
+ void leftIndent(Length const &);
+
+ /// read the parameters from a string
+ void read (std::string const & str, bool merge = true);
+
+ /// read the parameters from a lex
+ void read(support::Lexer & lex, bool merge = true);
+
///
- void pextraWidthp(string const &);
+ 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:
///
- int pextraAlignment() const;
+ Spacing spacing_;
///
- void pextraAlignment(int);
+ bool noindent_;
///
- bool pextraHfill() const;
+ bool start_of_appendix_;
///
- void pextraHfill(bool);
+ bool appendix_;
///
- bool pextraStartMinipage() const;
+ LyXAlignment align_;
///
- void pextraStartMinipage(bool);
-#endif
-private:
+ depth_type depth_;
///
- void set_from_struct(ParameterStruct const &);
+ docstring labelstring_;
///
- boost::shared_ptr<ParameterStruct> param;
+ docstring labelwidthstring_;
///
- static ShareContainer<ParameterStruct> container;
+ 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