X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FParagraphParameters.h;h=f651068f06055a6cba5395a416a9bb97fc3c80cd;hb=4c11ba11fdfa84b4cb36b7ee20cfadb749baa19d;hp=c48e128017a2c424e387aa885c70f0431d4b31dd;hpb=99d1627a471b92f403598d03dfc861ddc3c11be0;p=lyx.git diff --git a/src/ParagraphParameters.h b/src/ParagraphParameters.h index c48e128017..f651068f06 100644 --- a/src/ParagraphParameters.h +++ b/src/ParagraphParameters.h @@ -1,15 +1,34 @@ // -*- 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" -class VSpace; + +namespace lyx { + +class BufferView; +class Layout; +class Length; +class Lexer; +class Paragraph; class Spacing; @@ -23,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 &); @@ -39,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); @@ -73,30 +66,65 @@ public: /// void appendix(bool); /// - string const & labelString() const; + docstring const & labelString() const; + /// + void labelString(docstring const &); /// - void labelString(string const &); + docstring const & labelWidthString() const; /// - string const & labelWidthString() const; + void labelWidthString(docstring const &); /// - void labelWidthString(string const &); + Length const & leftIndent() const; /// - LyXLength const & leftIndent() 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(Lexer & lex, bool merge = true); + /// - void leftIndent(LyXLength 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: /// - void set_from_struct(ParameterStruct const &); + Spacing spacing_; + /// + bool noindent_; + /// + bool start_of_appendix_; /// - boost::shared_ptr param; + bool appendix_; /// - static ShareContainer container; + LyXAlignment align_; + /// + depth_type depth_; + /// + 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