src/insets/InsetArgument.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetArgument.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETARGUMENT_H
  13 #define INSETARGUMENT_H
  14
  15
  16 #include "InsetCollapsible.h"
  17
  18
  19 namespace lyx {
  20
  21
  22 /**
  23  * InsetArgument. Used to insert a short version of sectioning header etc.
  24  * automatically, or other optional LaTeX arguments
  25  */
  26 class InsetArgument : public InsetCollapsible
  27 {
  28 public:
  29         ///
  30         InsetArgument(Buffer *, std::string const &);
  31
  32         ///
  33         InsetArgument const * asInsetArgument() const override { return this; }
  34
  35         /// Outputting the parameter of a LaTeX command
  36         void latexArgument(otexstream & os, OutputParams const & runparams_in,
  37                            docstring const & ldelim, docstring const & rdelim,
  38                            docstring const & presetarg) const;
  39
  40         std::string name() const { return name_; }
  41
  42         /// \name Public functions inherited from Inset class
  43         //@{
  44         ///
  45         bool hasSettings() const override { return false; }
  46         ///
  47         InsetCode lyxCode() const override { return ARG_CODE; }
  48         ///
  49         docstring layoutName() const override { return from_ascii("Argument"); }
  50         /// Update the label string of this inset
  51         void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
  52         ///
  53         void latex(otexstream &, OutputParams const &) const override { }
  54         ///
  55         int plaintext(odocstringstream &, OutputParams const &, size_t) const override { return 0; }
  56         ///
  57         void docbook(XMLStream &, OutputParams const &) const override { return; }
  58         ///
  59         docstring xhtml(XMLStream &, OutputParams const &) const override
  60                 { return docstring(); }
  61         ///
  62         void write(std::ostream & os) const override;
  63         ///
  64         void read(Lexer & lex) override;
  65         ///
  66         bool neverIndent() const override { return true; }
  67         ///
  68         std::string contextMenuName() const override;
  69         ///
  70         bool isPassThru() const override { return pass_thru_; }
  71         ///
  72         bool isFreeSpacing() const override { return free_spacing_; }
  73         ///
  74         bool isTocCaption() const { return is_toc_caption_; }
  75         ///
  76         bool resetFontEdit() const override { return false; }
  77         //@}
  78         /// \name Public functions inherited from InsetCollapsible class
  79         //@{
  80         ///
  81         InsetLayout::InsetDecoration decoration() const override;
  82         ///
  83         FontInfo getFont() const override;
  84         ///
  85         FontInfo getLabelfont() const override;
  86         ///
  87         ColorCode labelColor() const override;
  88         ///
  89         void setButtonLabel() override;
  90         //@}
  91         ///
  92         void addToToc(DocIterator const & dit, bool output_active,
  93                       UpdateType utype, TocBackend & backend) const override;
  94
  95 private:
  96         ///
  97         docstring toolTip(BufferView const & bv, int, int) const override;
  98         ///
  99         void fixParagraphLanguage(Language const *);
 100         ///
 101         std::string name_;
 102         ///
 103         docstring labelstring_;
 104         ///
 105         docstring tooltip_;
 106         ///
 107         FontInfo font_;
 108         ///
 109         FontInfo labelfont_;
 110         ///
 111         std::string decoration_;
 112         /// Are we in a pass-thru context?
 113         bool pass_thru_context_;
 114         /// Is the argument itself have an explicitly pass-thru?
 115         bool pass_thru_local_;
 116         /// Effective pass-thru setting (inherited or local)
 117         bool pass_thru_;
 118         ///
 119         bool free_spacing_;
 120         ///
 121         docstring pass_thru_chars_;
 122         /// Does this argument provide content for the TOC?
 123         bool is_toc_caption_;
 124         /// The type of Toc this is the caption of, empty otherwise.
 125         std::string caption_of_toc_;
 126         /// Specific line break macro
 127         std::string newline_cmd_;
 128
 129 protected:
 130         /// \name Protected functions inherited from Inset class
 131         //@{
 132         ///
 133         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
 134         ///
 135         void doDispatch(Cursor & cur, FuncRequest & cmd) override;
 136         ///
 137         Inset * clone() const override { return new InsetArgument(*this); }
 138         /// Is the content of this inset part of the immediate (visible) text sequence?
 139         bool isPartOfTextSequence() const override { return false; }
 140         //@}
 141 };
 142
 143
 144 } // namespace lyx
 145
 146 #endif // INSETARGUMENT_H