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 "InsetText.h"
  18
  19 #include "Box.h"
  20
  21 #include <map>
  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 *, InsetText::UsePlain = InsetText::PlainLayout);
  37         ///
  38         InsetCollapsable(InsetCollapsable const & rhs);
  39         ///
  40         virtual ~InsetCollapsable();
  41         ///
  42         InsetCollapsable * asInsetCollapsable() { return this; }
  43         ///
  44         InsetCollapsable const * asInsetCollapsable() const { return this; }
  45         ///
  46         docstring toolTip(BufferView const & bv, int x, int y) const;
  47         ///
  48         docstring layoutName() const { return from_ascii("Collapsable"); }
  49         ///
  50         void read(Lexer &);
  51         ///
  52         void write(std::ostream &) const;
  53         ///
  54         void metrics(MetricsInfo &, Dimension &) const;
  55         ///
  56         void draw(PainterInfo & pi, int x, int y) const;
  57
  58         /// return x,y of given position relative to the inset's baseline
  59         void cursorPos(BufferView const & bv, CursorSlice const & sl,
  60                 bool boundary, int & x, int & y) const;
  61         ///
  62         docstring const getNewLabel(docstring const & l) const;
  63         ///
  64         bool editable() const;
  65         ///
  66         bool hasSettings() const { return true; }
  67         /// Returns true if coordinates are over the inset's button.
  68         /// Always returns false when the inset does not have a
  69         /// button.
  70         bool clickable(BufferView const & bv, int x, int y) const;
  71         /// can we go further down on mouse click?
  72         bool descendable(BufferView const & bv) const;
  73         ///
  74         void setLabel(docstring const & l);
  75         ///
  76         virtual void setButtonLabel() {}
  77         ///
  78         virtual docstring const buttonLabel(BufferView const &) const;
  79         ///
  80         bool isOpen(BufferView const & bv) const
  81                 { return geometry(bv) != ButtonOnly; }
  82         ///
  83         enum CollapseStatus {
  84                 Collapsed,
  85                 Open
  86         };
  87         ///
  88         virtual void setStatus(Cursor & cur, CollapseStatus st);
  89         ///
  90         CollapseStatus status(BufferView const & bv) const;
  91         /** Of the old CollapseStatus we only keep the values
  92          *  Open and Collapsed.
  93          * We define a list of possible inset decoration
  94          * styles, and a list of possible (concrete, visual)
  95          * inset geometries. Relationships between them
  96          * (geometries in body of table):
  97          *
  98          *               \       CollapseStatus:
  99          *   Decoration:  \ Open                Collapsed
 100          *   -------------+-------------------------------
 101          *   Classic      | *) TopButton, <--x) ButtonOnly
 102          *                | LeftButton
 103          *   Minimalistic | NoButton            ButtonOnly
 104          *   Conglomerate | SubLabel            Corners
 105          *   ---------------------------------------------
 106          *   *) toggled by openinlined_
 107          *   x) toggled by auto_open_
 108          */
 109
 110         /// Default looks
 111         virtual InsetLayout::InsetDecoration decoration() const;
 112         /// Inset font
 113         virtual FontInfo getFont() const { return getLayout().font(); }
 114         /// Label font
 115         virtual FontInfo getLabelfont() const { return getLayout().labelfont(); }
 116         ///
 117         enum Geometry {
 118                 TopButton,
 119                 ButtonOnly,
 120                 NoButton,
 121                 LeftButton,
 122                 SubLabel,
 123                 Corners
 124         };
 125         /// Returns the geometry based on CollapseStatus
 126         /// (status_), auto_open_[BufferView] and openinlined_,
 127         /// and of course decoration().
 128         Geometry geometry(BufferView const & bv) const;
 129         ///
 130         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 131         ///
 132         bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
 133         ///
 134         ColorCode backgroundColor(PainterInfo const &) const
 135                 { return getLayout().bgcolor(); }
 136         ///
 137         ColorCode labelColor() const { return getLayout().labelfont().color(); }
 138         ///
 139         InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
 140
 141         ///
 142         virtual bool usePlainLayout() const { return true; }
 143         ///
 144         std::string contextMenu(BufferView const & bv, int x, int y) const;
 145         ///
 146         std::string contextMenuName() const;
 147 protected:
 148         ///
 149         void doDispatch(Cursor & cur, FuncRequest & cmd);
 150         ///
 151         void edit(Cursor & cur, bool front,
 152                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 153         ///
 154         Inset * editXY(Cursor & cur, int x, int y);
 155         ///
 156         mutable CollapseStatus status_;
 157 private:
 158         ///
 159         Dimension dimensionCollapsed(BufferView const & bv) const;
 160         ///
 161         docstring labelstring_;
 162
 163         /// FIXME: the variables below should be grouped in a View subclass (as in MVC)
 164
 165         ///
 166         mutable std::map<BufferView const *, Box> button_dim_;
 167         /// a substatus of the Open status, determined automatically in metrics
 168         mutable std::map<BufferView const *, bool> openinlined_;
 169         /// the inset will automatically open when the cursor is inside. This is
 170         /// dependent on the bufferview, compare with MathMacro::editing_.
 171         mutable std::map<BufferView const *, bool> auto_open_;
 172         /// changes color when mouse enters/leaves this inset
 173         mutable std::map<BufferView const *, bool> mouse_hover_;
 174 };
 175
 176 } // namespace lyx
 177
 178 #endif