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