lyx_mirror/src/ParagraphParameters.h
Richard Heck de373da67b Add LFUN_PARAGRAPH_PARAMS (= paragraph-params), used for changing a paragraph's alignment, spacing, etc. This is complementary to LFUN_PARAGRAPH_PARAMS_APPLY, which sets the parameters. The difference is that APPLY over-rides all existing parameters, setting any not given to the default, whereas this one simply changes those that are given. So
paragraph-params \align right
will align the paragraph right, leaving spacing, etc, as they were, whereas
  paragraph-params-apply \align right
will align the paragraph right but also reset all other parameters to defaults. Note, by the way, that this means that
  paragraph-params-apply
sets everything to default.

Some new arguments have also been introduced. These are:
  \indent
  \indent-toggle
  \spacing default
Of course, none of these are found in valid LyX files, but they are useful in menu bindings, etc.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19581 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-15 02:21:09 +00:00

134 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 "Layout.h"
#include "Length.h"
#include "Spacing.h"
#include "support/types.h"
#include "support/docstring.h"
#include <iosfwd>
#include <string>
namespace lyx {
class BufferView;
class Length;
class Lexer;
class Paragraph;
class Spacing;
///
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 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);
///
bool canApply(ParagraphParameters const & params, Layout const & layout);
/// write out the parameters to a stream
void write(std::ostream & os) const;
//friend bool operator==(ParameterStruct const & ps1,
//ParameterStruct const & ps2);
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