// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file insetcollapsable.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 2000 The LyX Team.
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
*
- *======================================================
+ * Full author contact details are available in file CREDITS.
*/
-
#ifndef INSETCOLLAPSABLE_H
#define INSETCOLLAPSABLE_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "inset.h"
+#include "insettext.h"
-#include "lyxinset.h"
+#include "box.h"
#include "lyxfont.h"
-#include "LColor.h"
-#if 1 // NEW_INSETS
-#include "lyxparagraph.h"
-#endif
-class Painter;
-class InsetText;
+#include <string>
+
+namespace lyx {
+
class LyXText;
+class Paragraph;
+class CursorSlice;
+
+namespace frontend { class Painter; }
+
+/** A collapsable text inset
-/** A colapsable text inset
-
*/
-class InsetCollapsable : public UpdatableInset {
+class InsetCollapsable : public InsetText {
public:
- ///
- enum UpdateCodes {
- NONE = 0,
- FULL
- };
- ///
- static int const TEXT_TO_TOP_OFFSET = 2;
- ///
- static int const TEXT_TO_BOTTOM_OFFSET = 2;
- ///
- InsetCollapsable();
- ///
- Inset * Clone(Buffer const &) const;
- ///
- void Read(Buffer const *, LyXLex &);
- ///
- void Write(Buffer const *, std::ostream &) const;
- ///
- int ascent(BufferView *, LyXFont const &) const;
- ///
- int descent(BufferView *, LyXFont const &) const;
- ///
- int width(BufferView *, LyXFont const & f) const;
- ///
- void draw(BufferView *, const LyXFont &, int , float &, bool) const;
- ///
- void update(BufferView *, LyXFont const &, bool =false);
- ///
- void Edit(BufferView *, int, int, unsigned int);
- ///
- EDITABLE Editable() const;
- ///
- bool InsertInset(BufferView *, Inset * inset);
- ///
- bool IsTextInset() const { return true; }
- ///
- bool doClearArea() const;
- ///
- void InsetUnlock(BufferView *);
- ///
- bool needFullRow() const { return !collapsed; }
- ///
- bool LockInsetInInset(BufferView *, UpdatableInset *);
- ///
- bool UnlockInsetInInset(BufferView *, UpdatableInset *, bool lr = false);
- ///
- bool UpdateInsetInInset(BufferView *, Inset *);
- ///
- unsigned int InsetInInsetY();
- ///
- void InsetButtonRelease(BufferView *, int, int, int);
- ///
- void InsetButtonPress(BufferView *, int, int, int);
- ///
- void InsetMotionNotify(BufferView *, int, int, int);
- ///
- void InsetKeyPress(XKeyEvent *);
- ///
- UpdatableInset::RESULT LocalDispatch(BufferView *, kb_action,
- string const &);
- ///
- int Latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
- ///
- int Ascii(Buffer const *, std::ostream &, int) const { return 0; }
- ///
- int Linuxdoc(Buffer const *, std::ostream &) const { return 0; }
- ///
- int DocBook(Buffer const *, std::ostream &) const { return 0; }
- ///
- void Validate(LaTeXFeatures & features) const;
- ///
- void GetCursorPos(BufferView *, int & x, int & y) const;
- ///
- void ToggleInsetCursor(BufferView *);
- ///
- UpdatableInset * GetLockingInset();
- ///
- UpdatableInset * GetFirstLockingInsetOfType(Inset::Code);
- ///
- void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
- ///
- void setLabel(string const & l) { label = l; }
- ///
- void setLabelFont(LyXFont & f) { labelfont = f; }
- ///
- void setAutoCollapse(bool f) { autocollapse = f; }
- ///
- int getMaxWidth(Painter & pain, UpdatableInset const *) const;
- ///
- LyXText * getLyXText(BufferView const *, bool const recursive) const;
- ///
- void deleteLyXText(BufferView *, bool recursive=true) const;
- ///
- void resizeLyXText(BufferView *) const;
+ ///
+ static int const TEXT_TO_TOP_OFFSET = 2;
+ ///
+ static int const TEXT_TO_BOTTOM_OFFSET = 2;
+ ///
+ InsetCollapsable(BufferParams const &, CollapseStatus status = Open);
+ ///
+ InsetCollapsable(InsetCollapsable const & rhs);
+ ///
+ void read(Buffer const &, LyXLex &);
+ ///
+ void write(Buffer const &, std::ostream &) const;
+ ///
+ bool metrics(MetricsInfo &, Dimension &) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ void drawSelection(PainterInfo & pi, int x, int y) const;
+ /// return x,y of given position relative to the inset's baseline
+ void cursorPos(BufferView const & bv, CursorSlice const & sl,
+ bool boundary, int & x, int & y) const;
+ ///
+ bool hitButton(FuncRequest const &) const;
+ ///
+ docstring const getNewLabel(docstring const & l) const;
+ ///
+ EDITABLE editable() const;
+ /// can we go further down on mouse click?
+ bool descendable() const;
+ ///
+ void setLabel(docstring const & l);
+ ///
+ virtual void setButtonLabel() {}
+ ///
+ void setLabelFont(LyXFont & f);
+ ///
+ bool isOpen() const { return status_ == Open || status_ == Inlined; }
+ ///
+ bool inlined() const { return status_ == Inlined; }
+ ///
+ CollapseStatus status() const;
+ ///
+ bool allowSpellCheck() const { return true; }
+ ///
+ bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
+ ///
+ void setStatus(LCursor & cur, CollapseStatus st);
+ ///
+ bool setMouseHover(bool mouse_hover);
protected:
- ///
- int ascent_collapsed(Painter &, LyXFont const &) const;
- ///
- int descent_collapsed(Painter &, LyXFont const &) const;
- ///
- int width_collapsed(Painter &, LyXFont const & f) const;
- ///
- void draw_collapsed(Painter & pain, const LyXFont &, int , float &) const;
- ///
- int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
-
- ///
- bool collapsed;
- ///
- LColor::color framecolor;
- ///
- LyXFont labelfont;
-#ifdef NEW_INSETS
-public:
-#endif
- ///
- InsetText * inset;
- // Instead of making these ints protected we could have a
- // protected method "clickInButton" (Lgb)
-protected:
- ///
- mutable int button_length;
- ///
- mutable int button_top_y;
- ///
- mutable int button_bottom_y;
+ ///
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+ ///
+ Dimension dimensionCollapsed() const;
+ ///
+ Box const & buttonDim() const;
+ ///
+ void edit(LCursor & cur, bool left);
+ ///
+ InsetBase * editXY(LCursor & cur, int x, int y);
+ ///
+ void setInlined() { status_ = Inlined; }
+ /// Is the width forced to some value?
+ virtual bool hasFixedWidth() const { return false; }
+ ///
+ docstring floatName(std::string const & type, BufferParams const &);
+protected:
+ ///
+ LyXFont labelfont_;
+ ///
+ mutable Box button_dim;
+ ///
+ mutable int topx;
+ ///
+ mutable int topbaseline;
+ ///
+ mutable docstring label;
private:
- ///
- string label;
- ///
- bool autocollapse;
- ///
- int widthCollapsed;
- ///
- mutable int oldWidth;
- ///
- mutable int topx;
- mutable int topbaseline;
- mutable UpdateCodes need_update;
+ ///
+ mutable CollapseStatus status_;
+ /// a substatus of the Open status, determined automatically in metrics
+ mutable bool openinlined_;
+ /// the inset will automatically open when the cursor is inside
+ mutable bool autoOpen_;
+ ///
+ mutable Dimension textdim_;
+ /// changes color when mouse enters/leaves this inset
+ bool mouse_hover_;
};
+// A helper function that pushes the cursor out of the inset.
+void leaveInset(LCursor & cur, InsetBase const & in);
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff