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 "lyxfont.h"
  22
  23 class Painter;
  24 class LyXText;
  25 class Paragraph;
  26 class LyXCursor;
  27
  28 /** A collapsable text inset
  29
  30 */
  31 class InsetCollapsable : public UpdatableInset {
  32 public:
  33         ///
  34         static int const TEXT_TO_TOP_OFFSET = 2;
  35         ///
  36         static int const TEXT_TO_BOTTOM_OFFSET = 2;
  37         /// inset is initially collapsed if bool = true
  38         InsetCollapsable(BufferParams const &, bool collapsed = false);
  39         ///
  40         InsetCollapsable(InsetCollapsable const & in);
  41         ///
  42         void read(Buffer const &, LyXLex &);
  43         ///
  44         void write(Buffer const &, std::ostream &) const;
  45         ///
  46         void metrics(MetricsInfo &, Dimension &) const;
  47         ///
  48         void draw(PainterInfo & pi, int x, int y) const;
  49         /// draw, either inlined (no button) or collapsed/open
  50         void draw(PainterInfo & pi, int x, int y, bool inlined) const;
  51         ///
  52         bool hitButton(FuncRequest const &) const;
  53         ///
  54         EDITABLE editable() const;
  55         /// can we go further down on mouse click?
  56         bool descendable() const { return isOpen(); }
  57         ///
  58         bool insertInset(BufferView *, InsetOld * inset);
  59         ///
  60         bool insetAllowed(InsetOld::Code code) const;
  61         ///
  62         bool isTextInset() const { return true; }
  63         ///
  64         int insetInInsetY() const;
  65         ///
  66         int latex(Buffer const &, std::ostream &,
  67                   OutputParams const &) const;
  68         ///
  69         int plaintext(Buffer const &, std::ostream &,
  70                   OutputParams const &) const;
  71         ///
  72         int linuxdoc(Buffer const &, std::ostream &,
  73                      OutputParams const &) const;
  74         ///
  75         int docbook(Buffer const &, std::ostream &,
  76                     OutputParams const & runparams) const;
  77         ///
  78         void validate(LaTeXFeatures & features) const;
  79         /// get the screen x,y of the cursor
  80         void getCursorPos(int & x, int & y) const;
  81         ///
  82         void setLabel(std::string const & l) const;
  83         ///
  84         void setLabelFont(LyXFont & f);
  85 #if 0
  86         ///
  87         void setAutoCollapse(bool f);
  88 #endif
  89         /// Appends \c list with all labels found within this inset.
  90         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
  91         ///
  92         int scroll(bool recursive=true) const;
  93         ///
  94         void scroll(BufferView *bv, float sx) const;
  95         ///
  96         void scroll(BufferView *bv, int offset) const;
  97         ///
  98         ParagraphList * getParagraphs(int) const;
  99         ///
 100         int numParagraphs() const;
 101         ///
 102         LyXText * getText(int) const;
 103         ///
 104         bool display() const { return isOpen(); }
 105         ///
 106         bool isOpen() const;
 107         ///
 108         void open();
 109         ///
 110         void close() const;
 111         ///
 112         void markErased();
 113         ///
 114         void addPreview(lyx::graphics::PreviewLoader &) const;
 115
 116 protected:
 117         ///
 118         virtual
 119         DispatchResult
 120         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 121         ///
 122         void dimension_collapsed(Dimension &) const;
 123         ///
 124         int height_collapsed() const;
 125         ///
 126         void draw_collapsed(PainterInfo & pi, int x, int y) const;
 127         ///
 128         int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
 129         /// Should be non-const...
 130         void setCollapsed(bool) const;
 131         ///
 132         Box const & buttonDim() const;
 133         ///
 134         void edit(BufferView *, bool);
 135         ///
 136         void edit(BufferView *, int, int);
 137
 138 private:
 139         ///
 140         DispatchResult lfunMouseRelease(FuncRequest const &);
 141         ///
 142         FuncRequest adjustCommand(FuncRequest const &);
 143
 144 public:
 145         ///
 146         mutable InsetText inset;
 147 private:
 148         ///
 149         mutable bool collapsed_;
 150         ///
 151         LyXFont labelfont_;
 152         ///
 153         mutable Box button_dim;
 154         ///
 155         mutable int topx;
 156         ///
 157         mutable int topbaseline;
 158         ///
 159         mutable std::string label;
 160 #if 0
 161         ///
 162         bool autocollapse;
 163 #endif
 164 };
 165
 166 #endif