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