// -*- 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 "lyxinset.h"
+#include "inset.h"
+#include "insettext.h"
#include "lyxfont.h"
+#include "funcrequest.h" // for adjustCommand
#include "LColor.h"
+#include "box.h"
+#include <boost/weak_ptr.hpp>
class Painter;
-class InsetText;
class LyXText;
+class Paragraph;
+class LyXCursor;
+
+/** A collapsable text inset
-/** A colapsable text inset
-
*/
class InsetCollapsable : public UpdatableInset {
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() 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 *);
- ///
- 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 *, int, string const &);
- ///
- int Latex(Buffer const *, std::ostream &, bool fragile, bool free_spc) const;
- ///
- int Ascii(Buffer const *, std::ostream &) 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;
- void deleteLyXText(BufferView *) const;
+ ///
+ static int const TEXT_TO_TOP_OFFSET = 2;
+ ///
+ static int const TEXT_TO_BOTTOM_OFFSET = 2;
+ /// inset is initially collapsed if bool = true
+ InsetCollapsable(BufferParams const &, bool collapsed = false);
+ ///
+ InsetCollapsable(InsetCollapsable const & in);
+ ///
+ void read(Buffer const *, LyXLex &);
+ ///
+ void write(Buffer const *, std::ostream &) const;
+ ///
+ void metrics(MetricsInfo &, Dimension &) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
+ /// draw, either inlined (no button) or collapsed/open
+ void draw(PainterInfo & pi, int x, int y, bool inlined) const;
+ ///
+ bool hitButton(FuncRequest const &) const;
+ ///
+ EDITABLE editable() const;
+ ///
+ bool insertInset(BufferView *, InsetOld * inset);
+ ///
+ virtual bool insetAllowed(InsetOld::Code code) const {
+ return inset.insetAllowed(code);
+ }
+ ///
+ bool isTextInset() const { return true; }
+ ///
+ void insetUnlock(BufferView *);
+ ///
+ bool needFullRow() const { return isOpen(); }
+ ///
+ bool lockInsetInInset(BufferView *, UpdatableInset *);
+ ///
+ bool unlockInsetInInset(BufferView *, UpdatableInset *,
+ bool lr = false);
+ ///
+ bool updateInsetInInset(BufferView *, InsetOld *);
+ ///
+ int insetInInsetY() const;
+ ///
+ RESULT localDispatch(FuncRequest const &);
+ ///
+ int latex(Buffer const *, std::ostream &,
+ LatexRunParams const &) const;
+ ///
+ int ascii(Buffer const *, std::ostream &, int) const;
+ ///
+ int linuxdoc(Buffer const *, std::ostream &) const;
+ ///
+ int docbook(Buffer const *, std::ostream &, bool mixcont) const;
+ ///
+ void validate(LaTeXFeatures & features) const;
+ /// FIXME, document
+ void getCursorPos(BufferView *, int & x, int & y) const;
+ /// Get the absolute document x,y of the cursor
+ virtual void getCursor(BufferView &, int &, int &) const;
+ ///
+ void fitInsetCursor(BufferView * bv) const {
+ inset.fitInsetCursor(bv);
+ }
+ UpdatableInset * getLockingInset() const;
+ ///
+ UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
+ ///
+ void setFont(BufferView *, LyXFont const &, bool toggleall = false,
+ bool selectall = false);
+ ///
+ void setLabel(string const & l) const;
+ ///
+ void setLabelFont(LyXFont & f) { labelfont = f; }
+#if 0
+ ///
+ void setAutoCollapse(bool f) { autocollapse = f; }
+#endif
+ ///
+ LyXText * getLyXText(BufferView const *, bool const recursive) const;
+ ///
+ void deleteLyXText(BufferView *, bool recursive=true) const;
+ ///
+ void resizeLyXText(BufferView *, bool force = false) const;
+ ///
+ void getLabelList(std::vector<string> &) const;
+ ///
+ bool nodraw() const;
+ ///
+ int scroll(bool recursive=true) const;
+ ///
+ void scroll(BufferView *bv, float sx) const {
+ UpdatableInset::scroll(bv, sx);
+ }
+ ///
+ void scroll(BufferView *bv, int offset) const {
+ UpdatableInset::scroll(bv, offset);
+ }
+ ///
+ InsetOld * getInsetFromID(int id) const;
+ ///
+ ParagraphList * getParagraphs(int) const;
+ ///
+ LyXCursor const & cursor(BufferView *) const;
+ ///
+ bool isOpen() const { return !collapsed_; }
+ ///
+ void open(BufferView *);
+ ///
+ void close(BufferView *) const;
+ ///
+ bool allowSpellcheck() const { return inset.allowSpellcheck(); }
+ ///
+ WordLangTuple const
+ selectNextWordToSpellcheck(BufferView *, float &) const;
+ ///
+ void selectSelectedWord(BufferView * bv) {
+ inset.selectSelectedWord(bv);
+ }
+ ///
+ void toggleSelection(BufferView * bv, bool kill_selection) {
+ inset.toggleSelection(bv, kill_selection);
+ }
+
+ void markErased();
+
+ bool nextChange(BufferView * bv, lyx::pos_type & length);
+
+ ///
+ bool searchForward(BufferView * bv, string const & str,
+ bool = true, bool = false);
+ bool searchBackward(BufferView * bv, string const & str,
+ bool = true, bool = false);
+
+ ///
+ void addPreview(lyx::graphics::PreviewLoader &) const;
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;
- ///
- InsetText * inset;
- // Instead of making these ints protected we could have a
- // protected method "clickInButton" (Lgb)
- ///
- mutable int
- button_length, button_top_y, button_bottom_y;
+ ///
+ virtual void cache(BufferView *) const;
+ ///
+ virtual BufferView * view() const;
+
+ ///
+ void dimension_collapsed(Dimension &) const;
+ ///
+ int height_collapsed() const;
+ ///
+ void draw_collapsed(PainterInfo & pi, int x, int y) const;
+ ///
+ int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
+
+ ///
+ mutable bool collapsed_;
+ ///
+ LColor::color framecolor;
+ ///
+ LyXFont labelfont;
+public:
+ ///
+ mutable InsetText inset;
+protected:
+ ///
+ mutable Box button_dim;
+ ///
+ mutable int topx;
+ mutable int topbaseline;
private:
- ///
- string label;
- ///
- bool autocollapse;
- ///
- int widthCollapsed;
- ///
- int oldWidth;
- ///
- mutable int topx;
- mutable int topbaseline;
- mutable UpdateCodes need_update;
+ ///
+ void lfunMouseRelease(FuncRequest const &);
+ ///
+ FuncRequest adjustCommand(FuncRequest const &);
+
+ ///
+ mutable string label;
+#if 0
+ ///
+ bool autocollapse;
+#endif
+ ///
+ mutable int oldWidth;
+ ///
+ bool in_update;
+ ///
+ mutable bool first_after_edit;
+ ///
+ mutable boost::weak_ptr<BufferView> view_;
};
#endif