mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-29 21:05:12 +00:00
128 lines
2.4 KiB
C++
128 lines
2.4 KiB
C++
// -*- 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 "LayoutEnums.h"
|
|
#include "Spacing.h"
|
|
|
|
#include "support/types.h"
|
|
#include "support/strfwd.h"
|
|
#include "support/Length.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class Layout;
|
|
class Lexer;
|
|
class Paragraph;
|
|
|
|
|
|
///
|
|
class ParagraphParameters {
|
|
public:
|
|
///
|
|
ParagraphParameters();
|
|
///
|
|
void clear();
|
|
///
|
|
bool sameLayout(ParagraphParameters const &) const;
|
|
///
|
|
Spacing const & spacing() const;
|
|
///
|
|
void spacing(Spacing const &);
|
|
///
|
|
bool noindent() const;
|
|
///
|
|
void noindent(bool);
|
|
///
|
|
LyXAlignment align() const;
|
|
///
|
|
void align(LyXAlignment);
|
|
///
|
|
depth_type depth() const;
|
|
///
|
|
void depth(depth_type);
|
|
///
|
|
bool startOfAppendix() const;
|
|
///
|
|
void startOfAppendix(bool);
|
|
///
|
|
bool appendix() const;
|
|
///
|
|
void appendix(bool);
|
|
///
|
|
docstring const & labelString() const;
|
|
///
|
|
void labelString(docstring const &);
|
|
///
|
|
docstring const & labelWidthString() const;
|
|
///
|
|
void labelWidthString(docstring const &);
|
|
///
|
|
Length const & leftIndent() 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(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:
|
|
///
|
|
Spacing spacing_;
|
|
///
|
|
bool noindent_;
|
|
///
|
|
bool start_of_appendix_;
|
|
///
|
|
bool appendix_;
|
|
///
|
|
LyXAlignment align_;
|
|
///
|
|
depth_type depth_;
|
|
///
|
|
docstring labelstring_;
|
|
///
|
|
docstring labelwidthstring_;
|
|
///
|
|
Length leftindent_;
|
|
};
|
|
|
|
|
|
|
|
/** 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
|