* Licence details can be found in the file COPYING.
*
* \author Alejandro Aguilar Sierra
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETCOLLAPSABLE_H
#define INSETCOLLAPSABLE_H
-#include "Inset.h"
#include "InsetText.h"
#include "Box.h"
-#include "TextClass.h"
-#include "TextClassPtr.h"
-#include <string>
+#include <map>
namespace lyx {
class CursorSlice;
-class FontInfo;
class InsetLayout;
-class Paragraph;
-class Text;
namespace frontend { class Painter; }
class InsetCollapsable : public InsetText {
public:
///
- InsetCollapsable(
- BufferParams const &,
- CollapseStatus status = Inset::Open,
- TextClassPtr tc = TextClassPtr((TextClass *)0)
- );
+ InsetCollapsable(Buffer *, InsetText::UsePlain = InsetText::PlainLayout);
///
InsetCollapsable(InsetCollapsable const & rhs);
///
+ virtual ~InsetCollapsable();
+ ///
InsetCollapsable * asInsetCollapsable() { return this; }
///
InsetCollapsable const * asInsetCollapsable() const { return this; }
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
- docstring name() const { return from_ascii("Collapsable"); }
- ///
- InsetLayout const & getLayout(BufferParams const &) const
- { return *layout_; }
- ///
- InsetLayout const & getLayout() const
- { return *layout_; }
- ///
- void setLayout(BufferParams const &);
- /// (Re-)set the character style parameters from \p tc according
- /// to name()
- void setLayout(TextClassPtr tc);
+ docstring layoutName() const { return from_ascii("Collapsable"); }
///
- virtual bool useEmptyLayout() { return true; }
+ void read(Lexer &);
///
- void read(Buffer const &, Lexer &);
- ///
- void write(Buffer const &, std::ostream &) const;
+ void write(std::ostream &) const;
///
void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ virtual void drawBackground(PainterInfo &, int, int) 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;
+ bool boundary, int & x, int & y) const;
///
docstring const getNewLabel(docstring const & l) const;
///
- EDITABLE editable() const;
- /// can we go further down on mouse click?
- bool descendable() const;
+ bool editable() const;
///
- bool isMacroScope(Buffer const & buf) const;
+ bool hasSettings() const { return true; }
+ /// Returns true if coordinates are over the inset's button.
+ /// Always returns false when the inset does not have a
+ /// button.
+ bool clickable(BufferView const & bv, int x, int y) const;
+ /// can we go further down on mouse click?
+ bool descendable(BufferView const & bv) const;
///
void setLabel(docstring const & l);
///
virtual void setButtonLabel() {}
///
- bool isOpen() const { return geometry() != ButtonOnly; }
+ virtual docstring const buttonLabel(BufferView const &) const;
+ ///
+ bool isOpen(BufferView const & bv) const
+ { return geometry(bv) != ButtonOnly; }
+ ///
+ enum CollapseStatus {
+ Collapsed,
+ Open
+ };
///
- CollapseStatus status() const;
- /** Of the old CollapseStatus we only keep the values
+ virtual void setStatus(Cursor & cur, CollapseStatus st);
+ ///
+ CollapseStatus status(BufferView const & bv) const;
+ /** Of the old CollapseStatus we only keep the values
* Open and Collapsed.
* We define a list of possible inset decoration
* styles, and a list of possible (concrete, visual)
* Conglomerate | SubLabel Corners
* ---------------------------------------------
* *) toggled by openinlined_
- * x) toggled by autoOpen_
+ * x) toggled by auto_open_
*/
/// Default looks
virtual InsetLayout::InsetDecoration decoration() const;
+ /// Inset font
+ virtual FontInfo getFont() const { return getLayout().font(); }
+ /// Label font
+ virtual FontInfo getLabelfont() const { return getLayout().labelfont(); }
///
enum Geometry {
TopButton,
Corners
};
/// Returns the geometry based on CollapseStatus
- /// (status_), autoOpen_ and openinlined_, and of
- /// course decoration().
- Geometry geometry() const;
- ///
- bool allowSpellCheck() const { return true; }
+ /// (status_), auto_open_[BufferView] and openinlined_,
+ /// and of course decoration().
+ Geometry geometry(BufferView const & bv) const;
///
- bool allowMultiPar() const;
+ bool canPaintChange(BufferView const & bv) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
- void setStatus(Cursor & cur, CollapseStatus st);
+ bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
///
- bool setMouseHover(bool mouse_hover);
+ ColorCode backgroundColor(PainterInfo const &) const
+ { return getLayout().bgcolor(); }
///
- virtual ColorCode backgroundColor() const {return layout_->bgcolor(); }
+ ColorCode labelColor() const { return getLayout().labelfont().color(); }
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
+
///
- void validate(LaTeXFeatures &) const;
+ virtual bool usePlainLayout() const { return true; }
///
- virtual InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
-
- /// Allow multiple blanks
- virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
- /// Don't eliminate empty paragraphs
- virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
- /// Force inset into LTR environment if surroundings are RTL?
- virtual bool forceLTR() const { return layout_->isForceLtr(); }
+ std::string contextMenu(BufferView const & bv, int x, int y) const;
///
- virtual bool useEmptyLayout() const { return true; }
- /// Is this inset's layout defined in the document's textclass?
- /// May be wrong after textclass change or paste from another document
- bool undefined() const;
+ std::string contextMenuName() const;
protected:
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- void edit(Cursor & cur, bool front,
+ void edit(Cursor & cur, bool front,
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
Inset * editXY(Cursor & cur, int x, int y);
///
- docstring floatName(std::string const & type, BufferParams const &) const;
- ///
- virtual void resetParagraphsFont();
-
+ mutable CollapseStatus status_;
private:
- /// text class to keep the InsetLayout above in memory
- TextClassPtr textClass_;
- /// cache for the layout_. Make sure it is in sync with the text class!
- InsetLayout const * layout_;
///
- Dimension dimensionCollapsed() const;
+ Dimension dimensionCollapsed(BufferView const & bv) const;
///
docstring labelstring_;
+
+ // These variables depend of the view in which the inset is displayed
+ struct View
+ {
+ /// The dimension of the inset button
+ Box button_dim_;
+ /// a substatus of the Open status, determined automatically in metrics
+ bool openinlined_;
+ /// the inset will automatically open when the cursor is inside. This is
+ /// dependent on the bufferview, compare with MathMacro::editing_.
+ bool auto_open_;
+ /// changes color when mouse enters/leaves this inset
+ bool mouse_hover_;
+ };
+
///
- mutable Box button_dim;
- ///
- 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_;
- /// changes color when mouse enters/leaves this inset
- bool mouse_hover_;
+ mutable std::map<BufferView const *, View> view_;
};
} // namespace lyx
projects / lyx.git / blobdiff