* Licence details can be found in the file COPYING.
*
* \author Jean-Marc Lasgouttes
+ * \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_QUOTES_H
#define INSET_QUOTES_H
-
#include "Inset.h"
-#include "support/types.h"
+#include "support/docstring.h"
namespace lyx {
-class BufferParams;
-class Language;
-class LaTeXFeatures;
-
-
/** Quotes.
Used for the various quotes. German, English, French, all either
double or single **/
-class InsetQuotes : public Inset {
+class InsetQuotesParams {
public:
///
- enum quote_language {
+ enum QuoteStyle {
+ ///
+ EnglishQuotes,
+ ///
+ SwedishQuotes,
+ ///
+ GermanQuotes,
+ ///
+ PolishQuotes,
+ ///
+ SwissQuotes,
+ ///
+ DanishQuotes,
///
- EnglishQ,
+ PlainQuotes,
///
- SwedishQ,
+ BritishQuotes,
///
- GermanQ,
+ SwedishGQuotes,
///
- PolishQ,
+ FrenchQuotes,
///
- FrenchQ,
+ FrenchINQuotes,
///
- DanishQ
+ RussianQuotes,
+ ///
+ CJKQuotes,
+ ///
+ CJKAngleQuotes,
+ ///
+ DynamicQuotes
};
///
- enum quote_side {
+ enum QuoteSide {
///
- LeftQ,
+ OpeningQuote,
///
- RightQ
+ ClosingQuote
};
///
- enum quote_times {
+ enum QuoteLevel {
///
- SingleQ,
+ SecondaryQuotes,
///
- DoubleQ
+ PrimaryQuotes
};
+ /// Returns the unicode character of a given quote
+ char_type getQuoteChar(QuoteStyle const &, QuoteLevel const &,
+ QuoteSide const &, bool const rtl = false) const;
+ /// Returns a map of quotation marks
+ std::map<std::string, docstring> getTypes() const;
+ ///
+ docstring getLaTeXQuote(char_type c, std::string const &,
+ bool const rtl = false) const;
+ ///
+ docstring getHTMLQuote(char_type c) const;
+ ///
+ docstring getXMLQuote(char_type c) const;
+ /// Returns a descriptive label of a style suitable for dialog and menu
+ docstring const getGuiLabel(QuoteStyle const & qs,
+ bool langdef = false);
+ /// Returns a descriptive label of a given char
+ docstring const getShortGuiLabel(docstring const & str);
+ ///
+ int stylescount() const;
+ /// Returns the matching style shortcut char
+ char getStyleChar(QuoteStyle const & style) const;
+ /// Returns the quote style from the shortcut string
+ QuoteStyle getQuoteStyle(std::string const & s,
+ bool const allow_wildcards = false,
+ QuoteStyle fallback = EnglishQuotes);
+ /// Returns the quote sind from the shortcut string
+ QuoteSide getQuoteSide(std::string const & s,
+ bool const allow_wildcards = false,
+ QuoteSide fallback = OpeningQuote);
+ /// Returns the quote level from the shortcut string
+ QuoteLevel getQuoteLevel(std::string const & s,
+ bool const allow_wildcards = false,
+ QuoteLevel fallback = PrimaryQuotes);
+};
+///
+extern InsetQuotesParams quoteparams;
+
+/** Quotes.
+ Used for the various quotes. German, English, French, all either
+ double or single **/
+class InsetQuotes : public Inset
+{
+public:
/** The constructor works like this:
\begin{itemize}
\item fls <- french single quote left
\item etc.
\end{itemize}
*/
- explicit
- InsetQuotes(std::string const & str = "eld");
- /// Create the right quote inset after character c
- InsetQuotes(char_type c, BufferParams const & params);
+ explicit InsetQuotes(Buffer * buf, std::string const & str = "eld");
/// Direct access to inner/outer quotation marks
- InsetQuotes(char_type c, quote_language l, quote_times t);
+ InsetQuotes(Buffer * buf, char_type c, InsetQuotesParams::QuoteLevel level,
+ std::string const & side = std::string(),
+ std::string const & style = std::string());
///
- docstring insetName() const { return from_ascii("Quotes"); }
+ docstring layoutName() const;
///
- bool metrics(MetricsInfo &, Dimension &) const;
+ void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
-#if 0
///
- LyXFont const convertFont(LyXFont const & font) const;
-#endif
+ void write(std::ostream &) const;
+ ///
+ void read(Lexer & lex);
///
- void write(Buffer const &, std::ostream &) const;
+ bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
- void read(Buffer const &, Lexer & lex);
+ void latex(otexstream &, OutputParams const &) const;
///
- int latex(Buffer const &, odocstream &, OutputParams const &) const;
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const;
///
- int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+ void docbook(XMLStream &, OutputParams const &) const;
///
- int docbook(Buffer const &, odocstream &, OutputParams const &) const;
+ docstring xhtml(XMLStream &, OutputParams const &) const;
- /// the string that is passed to the TOC
- virtual void textString(Buffer const &, odocstream &) const;
+ ///
+ void toString(odocstream &) const;
+ ///
+ void forOutliner(docstring &, size_t const maxlen, bool const) const;
+
+ /// Update the contextual information of this inset
+ void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
///
void validate(LaTeXFeatures &) const;
///
- Inset::Code lyxCode() const;
- // should this inset be handled like a normal character
+ std::string contextMenuName() const;
+ ///
+ InsetCode lyxCode() const { return QUOTE_CODE; }
+ /// should this inset be handled like a normal character
bool isChar() const { return true; }
+ /// Returns the current quote type
+ std::string getType() const;
+
private:
- virtual std::auto_ptr<Inset> doClone() const;
+ ///
+ Inset * clone() const { return new InsetQuotes(*this); }
+ /// Decide whether we need left or right quotation marks
+ void setSide(char_type c);
+ ///
+ void parseString(std::string const &,
+ bool const allow_wildcards = false);
///
- quote_language language_;
+ docstring displayString() const;
///
- quote_side side_;
+ docstring getQuoteEntity(bool isHTML) const;
///
- quote_times times_;
+ InsetQuotesParams::QuoteStyle getStyle(std::string const &);
- /** The parameters of the constructor are the language, the
- side and the multiplicity of the quote.
- */
- InsetQuotes(quote_language l, quote_side s, quote_times t);
- /// Decide whether we need left or right quotation marks
- void getPosition(char_type c);
///
- void parseString(std::string const &);
+ InsetQuotesParams::QuoteStyle style_;
+ ///
+ InsetQuotesParams::QuoteSide side_;
+ ///
+ InsetQuotesParams::QuoteLevel level_;
+ ///
+ InsetQuotesParams::QuoteStyle global_style_;
+ /// Current font encoding
+ std::string fontenc_;
+ /// Code of the contextual language
+ std::string context_lang_;
+ /// Is this in a pass-thru context?
+ bool pass_thru_;
+ /// Do we use fontspec?
+ bool fontspec_;
+ /// Do we have an internal font encoding?
+ bool internal_fontenc_;
+ /// Are we writing RTL?
+ bool rtl_;
+ ///
+ friend class InsetQuotesParams;
+
+protected:
+ /// \name Protected functions inherited from Inset class
+ //@{
///
- lyx::docstring const dispString(Language const *) const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+ //@}
};
} // namespace lyx