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         ///
  56         bool insertInset(BufferView *, InsetOld * inset);
  57         ///
  58         virtual bool insetAllowed(InsetOld::Code code) const;
  59         ///
  60         bool isTextInset() const;
  61         ///
  62         void insetUnlock(BufferView *);
  63         ///
  64         bool lockInsetInInset(BufferView *, UpdatableInset *);
  65         ///
  66         bool unlockInsetInInset(BufferView *, UpdatableInset *,
  67                                 bool lr = false);
  68         ///
  69         int insetInInsetY() const;
  70         ///
  71         int latex(Buffer const &, std::ostream &,
  72                   OutputParams const &) const;
  73         ///
  74         int plaintext(Buffer const &, std::ostream &,
  75                   OutputParams const &) const;
  76         ///
  77         int linuxdoc(Buffer const &, std::ostream &,
  78                      OutputParams const &) const;
  79         ///
  80         int docbook(Buffer const &, std::ostream &,
  81                     OutputParams const & runparams) const;
  82         ///
  83         void validate(LaTeXFeatures & features) const;
  84         /// FIXME, document
  85         void getCursorPos(BufferView *, int & x, int & y) const;
  86         /// Get the absolute document x,y of the cursor
  87         virtual void getCursor(BufferView &, int &, int &) const;
  88         ///
  89         void fitInsetCursor(BufferView * bv) const;
  90         ///
  91         UpdatableInset * getLockingInset() const;
  92         ///
  93         UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
  94         ///
  95         void setFont(BufferView *, LyXFont const &, bool toggleall = false,
  96                  bool selectall = false);
  97         ///
  98         void setLabel(std::string const & l) const;
  99         ///
 100         void setLabelFont(LyXFont & f);
 101 #if 0
 102         ///
 103         void setAutoCollapse(bool f);
 104 #endif
 105         ///
 106         LyXText * getLyXText(BufferView const *, bool const recursive) const;
 107         ///
 108         void deleteLyXText(BufferView *, bool recursive=true) const;
 109         /// Appends \c list with all labels found within this inset.
 110         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 111         ///
 112         int scroll(bool recursive=true) const;
 113         ///
 114         void scroll(BufferView *bv, float sx) const;
 115         ///
 116         void scroll(BufferView *bv, int offset) const;
 117         ///
 118         ParagraphList * getParagraphs(int) const;
 119         ///
 120         int numParagraphs() const;
 121         ///
 122         LyXText * getText(int) const;
 123         ///
 124         LyXCursor const & cursor(BufferView *) const;
 125         ///
 126         virtual bool display() const { return isOpen(); }
 127         ///
 128         bool isOpen() const;
 129         ///
 130         void open(BufferView *);
 131         ///
 132         void close(BufferView *) const;
 133
 134         void markErased();
 135
 136         ///
 137         void addPreview(lyx::graphics::PreviewLoader &) const;
 138
 139 protected:
 140         ///
 141         virtual
 142         DispatchResult
 143         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 144         ///
 145         void dimension_collapsed(Dimension &) const;
 146         ///
 147         int height_collapsed() const;
 148         ///
 149         void draw_collapsed(PainterInfo & pi, int x, int y) const;
 150         ///
 151         int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
 152         /// Should be non-const...
 153         void setCollapsed(bool) const;
 154         ///
 155         Box const & buttonDim() const;
 156         ///
 157         void edit(BufferView *, bool);
 158         ///
 159         void edit(BufferView *, int, int);
 160
 161 private:
 162         ///
 163         void lfunMouseRelease(FuncRequest const &);
 164         ///
 165         FuncRequest adjustCommand(FuncRequest const &);
 166
 167 public:
 168         ///
 169         mutable InsetText inset;
 170 private:
 171         ///
 172         mutable bool collapsed_;
 173         ///
 174         LyXFont labelfont_;
 175         ///
 176         mutable Box button_dim;
 177         ///
 178         mutable int topx;
 179         mutable int topbaseline;
 180
 181         ///
 182         mutable std::string label;
 183 #if 0
 184         ///
 185         bool autocollapse;
 186 #endif
 187         ///
 188         bool in_update;
 189         ///
 190         mutable bool first_after_edit;
 191 };
 192
 193
 194 inline
 195 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 196 {
 197         return inset.insetAllowed(code);
 198 }
 199
 200
 201 inline
 202 bool InsetCollapsable::isTextInset() const
 203 {
 204         return true;
 205 }
 206
 207
 208 inline
 209 void InsetCollapsable::fitInsetCursor(BufferView * bv) const
 210 {
 211         inset.fitInsetCursor(bv);
 212 }
 213
 214 inline
 215 void InsetCollapsable::setLabelFont(LyXFont & f)
 216 {
 217         labelfont_ = f;
 218 }
 219
 220 #if 0
 221 inline
 222 void InsetCollapsable::setAutoCollapse(bool f)
 223 {
 224         autocollapse = f;
 225 }
 226 #endif
 227
 228 inline
 229 void InsetCollapsable::scroll(BufferView *bv, float sx) const
 230 {
 231         UpdatableInset::scroll(bv, sx);
 232 }
 233
 234
 235 inline
 236 void InsetCollapsable::scroll(BufferView *bv, int offset) const
 237 {
 238         UpdatableInset::scroll(bv, offset);
 239 }
 240
 241
 242 inline
 243 bool InsetCollapsable::isOpen() const
 244 {
 245         return !collapsed_;
 246 }
 247
 248
 249 inline
 250 Box const & InsetCollapsable::buttonDim() const
 251 {
 252         return button_dim;
 253 }
 254
 255 #endif