src/insets/InsetCollapsable.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetCollapsable.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author Jürgen Vigna
   9  * \author Lars Gullik Bjønnes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef INSETCOLLAPSABLE_H
  15 #define INSETCOLLAPSABLE_H
  16
  17 #include "Inset.h"
  18 #include "InsetText.h"
  19
  20 #include "Box.h"
  21 #include "TextClass.h"
  22
  23 namespace lyx {
  24
  25 class CursorSlice;
  26 class InsetLayout;
  27
  28 namespace frontend { class Painter; }
  29
  30 /** A collapsable text inset
  31
  32 */
  33 class InsetCollapsable : public InsetText {
  34 public:
  35         ///
  36         InsetCollapsable(Buffer const &, InsetText::UsePlain = InsetText::PlainLayout);
  37         ///
  38         InsetCollapsable(InsetCollapsable const & rhs);
  39         ///
  40         InsetCollapsable * asInsetCollapsable() { return this; }
  41         ///
  42         InsetCollapsable const * asInsetCollapsable() const { return this; }
  43         ///
  44         docstring toolTip(BufferView const & bv, int x, int y) const;
  45         ///
  46         docstring name() const { return from_ascii("Collapsable"); }
  47         ///
  48         InsetLayout const & getLayout(BufferParams const &) const { return *layout_; }
  49         ///
  50         InsetLayout const & getLayout() const { return *layout_; }
  51         ///
  52         void setLayout(BufferParams const &);
  53         /// (Re-)set the character style parameters from \p tc according
  54         /// to name()
  55         void setLayout(DocumentClass const * const tc);
  56         ///
  57         virtual bool usePlainLayout() { return true; }
  58         ///
  59         void read(Lexer &);
  60         ///
  61         void write(std::ostream &) const;
  62         ///
  63         void metrics(MetricsInfo &, Dimension &) const;
  64         ///
  65         void draw(PainterInfo & pi, int x, int y) const;
  66
  67         /// return x,y of given position relative to the inset's baseline
  68         void cursorPos(BufferView const & bv, CursorSlice const & sl,
  69                 bool boundary, int & x, int & y) const;
  70         /// Returns true if (mouse) action is over the inset's button.
  71         /// Always returns false when the inset does not have a
  72         /// button.
  73         bool hitButton(FuncRequest const &) const;
  74         ///
  75         docstring const getNewLabel(docstring const & l) const;
  76         ///
  77         EDITABLE editable() const;
  78         /// can we go further down on mouse click?
  79         bool descendable() const;
  80         ///
  81         void setLabel(docstring const & l);
  82         ///
  83         virtual void setButtonLabel() {}
  84         ///
  85         virtual docstring const buttonLabel(BufferView const &) const
  86                 { return labelstring_; }
  87         ///
  88         bool isOpen(BufferView const & bv) const
  89                 { return geometry(bv) != ButtonOnly; }
  90         ///
  91         CollapseStatus status(BufferView const & bv) const;
  92         /** Of the old CollapseStatus we only keep the values
  93          *  Open and Collapsed.
  94          * We define a list of possible inset decoration
  95          * styles, and a list of possible (concrete, visual)
  96          * inset geometries. Relationships between them
  97          * (geometries in body of table):
  98          *
  99          *               \       CollapseStatus:
 100          *   Decoration:  \ Open                Collapsed
 101          *   -------------+-------------------------------
 102          *   Classic      | *) TopButton, <--x) ButtonOnly
 103          *                | LeftButton
 104          *   Minimalistic | NoButton            ButtonOnly
 105          *   Conglomerate | SubLabel            Corners
 106          *   ---------------------------------------------
 107          *   *) toggled by openinlined_
 108          *   x) toggled by auto_open_
 109          */
 110
 111         /// Default looks
 112         virtual InsetLayout::InsetDecoration decoration() const;
 113         ///
 114         enum Geometry {
 115                 TopButton,
 116                 ButtonOnly,
 117                 NoButton,
 118                 LeftButton,
 119                 SubLabel,
 120                 Corners
 121         };
 122         /// Returns the geometry based on CollapseStatus
 123         /// (status_), auto_open_[BufferView] and openinlined_,
 124         /// and of course decoration().
 125         Geometry geometry(BufferView const & bv) const;
 126         /// Returns the geometry disregarding auto_open_
 127         Geometry geometry() const;
 128         /// Allow spellchecking, except for insets with latex_language
 129         bool allowSpellCheck() const { return !forceLTR(); }
 130         ///
 131         bool allowMultiPar() const;
 132         ///
 133         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 134         ///
 135         void setStatus(Cursor & cur, CollapseStatus st);
 136         ///
 137         bool setMouseHover(bool mouse_hover);
 138         ///
 139         ColorCode backgroundColor() const { return layout_->bgcolor(); }
 140         ///
 141         int latex(odocstream &, OutputParams const &) const;
 142         ///
 143         int docbook(odocstream &, OutputParams const &) const;
 144         ///
 145         void validate(LaTeXFeatures &) const;
 146         ///
 147         InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
 148
 149         /// Allow multiple blanks
 150         virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
 151         /// Don't eliminate empty paragraphs
 152         virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
 153         /// Force inset into LTR environment if surroundings are RTL?
 154         virtual bool forceLTR() const { return layout_->isForceLtr(); }
 155         ///
 156         virtual bool usePlainLayout() const { return true; }
 157         /// Is this inset's layout defined in the document's textclass?
 158         /// May be wrong after textclass change or paste from another document
 159         bool undefined() const;
 160         /// the string that is passed to the TOC
 161         void tocString(odocstream &) const;
 162         ///
 163         virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
 164 protected:
 165         ///
 166         void doDispatch(Cursor & cur, FuncRequest & cmd);
 167         ///
 168         void edit(Cursor & cur, bool front,
 169                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 170         ///
 171         Inset * editXY(Cursor & cur, int x, int y);
 172         ///
 173         docstring floatName(std::string const & type, BufferParams const &) const;
 174         ///
 175         virtual void resetParagraphsFont();
 176         ///
 177         mutable CollapseStatus status_;
 178 private:
 179         /// cache for the layout_. Make sure it is in sync with the document class!
 180         InsetLayout const * layout_;
 181         ///
 182         Dimension dimensionCollapsed(BufferView const & bv) const;
 183         ///
 184         /// should paragraphs be forced to use the empty layout?
 185         virtual bool forcePlainLayout(idx_type = 0) const
 186                 { return getLayout().forcePlainLayout(); }
 187         /// should the user be allowed to customize alignment, etc.?
 188         virtual bool allowParagraphCustomization(idx_type = 0) const
 189                 { return getLayout().allowParagraphCustomization(); }
 190         docstring labelstring_;
 191         ///
 192         mutable Box button_dim;
 193         /// a substatus of the Open status, determined automatically in metrics
 194         mutable bool openinlined_;
 195         /// the inset will automatically open when the cursor is inside. This is
 196         /// dependent on the bufferview, compare with MathMacro::editing_.
 197         mutable std::map<BufferView const *, bool> auto_open_;
 198         /// changes color when mouse enters/leaves this inset
 199         bool mouse_hover_;
 200 };
 201
 202 } // namespace lyx
 203
 204 #endif