* 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.
*/
#include "Inset.h"
#include "InsetText.h"
-#include "TextClass.h"
#include "Box.h"
-
-#include <string>
+#include "TextClass.h"
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);
+ InsetCollapsable(Buffer const &, InsetText::UsePlain = InsetText::PlainLayout);
///
InsetCollapsable(InsetCollapsable const & rhs);
///
+ 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(DocumentClass const * const tc);
+ ///
+ virtual bool usePlainLayout() { return true; }
///
- void read(Buffer const &, Lexer &);
+ void read(Lexer &);
///
- void write(Buffer const &, std::ostream &) const;
+ void write(std::ostream &) const;
///
void metrics(MetricsInfo &, Dimension &) 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;
- ///
+ /// Returns true if (mouse) action is over the inset's button.
+ /// Always returns false when the inset does not have a
+ /// button.
bool hitButton(FuncRequest const &) const;
///
docstring const getNewLabel(docstring const & l) const;
///
- EDITABLE editable() const;
+ bool editable() const;
+ ///
+ bool hasSettings() const { return true; }
/// can we go further down on mouse click?
bool descendable() const;
///
///
virtual void setButtonLabel() {}
///
- void setLabelFont(FontInfo const & f);
+ virtual docstring const buttonLabel(BufferView const &) const
+ { return labelstring_; }
///
- void setLabelColor(ColorCode code);
+ bool isOpen(BufferView const & bv) const
+ { return geometry(bv) != ButtonOnly; }
///
- bool isOpen() const { return geometry() != ButtonOnly; }
- ///
- CollapseStatus status() const;
+ 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
* -------------+-------------------------------
* Classic | *) TopButton, <--x) ButtonOnly
* | LeftButton
- * Minimalistic | ButtonOnly NoButton
+ * Minimalistic | NoButton ButtonOnly
* Conglomerate | SubLabel Corners
* ---------------------------------------------
* *) toggled by openinlined_
- * x) toggled by autoOpen_
+ * x) toggled by auto_open_
*/
- ///
- enum Decoration {
- Classic,
- Minimalistic,
- Conglomerate
- };
/// Default looks
- virtual Decoration decoration() const;
+ virtual InsetLayout::InsetDecoration decoration() const;
///
enum Geometry {
TopButton,
Corners
};
/// Returns the geometry based on CollapseStatus
- /// (status_), autoOpen_ and openinlined_, and of
- /// course decoration().
+ /// (status_), auto_open_[BufferView] and openinlined_,
+ /// and of course decoration().
+ Geometry geometry(BufferView const & bv) const;
+ /// Returns the geometry disregarding auto_open_
Geometry geometry() const;
- ///
- bool allowSpellCheck() const { return true; }
+ /// Allow spellchecking, except for insets with latex_language
+ bool allowSpellCheck() const { return !forceLTR(); }
///
bool allowMultiPar() const;
///
///
bool setMouseHover(bool mouse_hover);
///
- virtual ColorCode backgroundColor() const {return layout_.bgcolor; }
-
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ ColorCode backgroundColor() const { return layout_->bgcolor(); }
+ ///
+ int latex(odocstream &, OutputParams const &) const;
+ ///
+ int docbook(odocstream &, OutputParams const &) const;
+ ///
+ int xhtml(odocstream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
- virtual InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
+ InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
/// Allow multiple blanks
- virtual bool isFreeSpacing() const { return layout_.freespacing; }
+ virtual bool isFreeSpacing() const { return layout_->isFreeSpacing(); }
/// Don't eliminate empty paragraphs
- virtual bool allowEmpty() const { return layout_.keepempty; }
-
+ virtual bool allowEmpty() const { return layout_->isKeepEmpty(); }
+ /// Force inset into LTR environment if surroundings are RTL?
+ virtual bool forceLTR() const { return layout_->isForceLtr(); }
+ ///
+ virtual bool usePlainLayout() 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;
+ /// the string that is passed to the TOC
+ void tocString(odocstream &) const;
+ ///
+ virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
protected:
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
- ///
- Dimension dimensionCollapsed() const;
- ///
- Box const & buttonDim() const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- void edit(Cursor & cur, bool left);
+ void edit(Cursor & cur, bool front,
+ EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
Inset * editXY(Cursor & cur, int x, int y);
///
///
virtual void resetParagraphsFont();
///
- virtual void getDrawFont(FontInfo &) const;
-
-protected:
- ///
- mutable Box button_dim;
- ///
- mutable int topx;
- ///
- mutable int topbaseline;
+ mutable CollapseStatus status_;
+private:
+ /// cache for the layout_. Make sure it is in sync with the document class!
+ InsetLayout const * layout_;
///
- mutable InsetLayout layout_;
+ Dimension dimensionCollapsed(BufferView const & bv) const;
///
- CollapseStatus internalStatus() const { return status_; }
-private:
+ /// should paragraphs be forced to use the empty layout?
+ virtual bool forcePlainLayout(idx_type = 0) const
+ { return getLayout().forcePlainLayout(); }
+ /// should the user be allowed to customize alignment, etc.?
+ virtual bool allowParagraphCustomization(idx_type = 0) const
+ { return getLayout().allowParagraphCustomization(); }
+ docstring labelstring_;
///
- mutable CollapseStatus status_;
+ mutable Box button_dim;
/// 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_;
+ /// the inset will automatically open when the cursor is inside. This is
+ /// dependent on the bufferview, compare with MathMacro::editing_.
+ mutable std::map<BufferView const *, bool> auto_open_;
/// changes color when mouse enters/leaves this inset
bool mouse_hover_;
};
-// A helper function that pushes the cursor out of the inset.
-void leaveInset(Cursor & cur, Inset const & in);
-
} // namespace lyx
#endif
projects / lyx.git / blobdiff