mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 16:18:22 +00:00
e194c9ce27
Now by default all insets paint their own background when needed. This means that63cf3297and part of9940acc5can be reverted. To avoid extra painting, background drawing is disabled for InsetCommand and InsetCollapsable. These insets draw background as part of their normal drawing activity. This will avoid drawing artifacts with InsetNewpage, InsetVSpace and probably some others.
188 lines
5.0 KiB
C++
188 lines
5.0 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetCollapsable.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \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
|
|
|
|
#include "InsetText.h"
|
|
|
|
#include "Box.h"
|
|
|
|
#include <map>
|
|
|
|
namespace lyx {
|
|
|
|
class CursorSlice;
|
|
class InsetLayout;
|
|
|
|
namespace frontend { class Painter; }
|
|
|
|
/** A collapsable text inset
|
|
|
|
*/
|
|
class InsetCollapsable : public InsetText {
|
|
public:
|
|
///
|
|
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 layoutName() const { return from_ascii("Collapsable"); }
|
|
///
|
|
void read(Lexer &);
|
|
///
|
|
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;
|
|
///
|
|
docstring const getNewLabel(docstring const & l) const;
|
|
///
|
|
bool editable() 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() {}
|
|
///
|
|
virtual docstring const buttonLabel(BufferView const &) const;
|
|
///
|
|
bool isOpen(BufferView const & bv) const
|
|
{ return geometry(bv) != ButtonOnly; }
|
|
///
|
|
enum CollapseStatus {
|
|
Collapsed,
|
|
Open
|
|
};
|
|
///
|
|
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)
|
|
* inset geometries. Relationships between them
|
|
* (geometries in body of table):
|
|
*
|
|
* \ CollapseStatus:
|
|
* Decoration: \ Open Collapsed
|
|
* -------------+-------------------------------
|
|
* Classic | *) TopButton, <--x) ButtonOnly
|
|
* | LeftButton
|
|
* Minimalistic | NoButton ButtonOnly
|
|
* Conglomerate | SubLabel Corners
|
|
* ---------------------------------------------
|
|
* *) toggled by openinlined_
|
|
* 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,
|
|
ButtonOnly,
|
|
NoButton,
|
|
LeftButton,
|
|
SubLabel,
|
|
Corners
|
|
};
|
|
/// Returns the geometry based on CollapseStatus
|
|
/// (status_), auto_open_[BufferView] and openinlined_,
|
|
/// and of course decoration().
|
|
Geometry geometry(BufferView const & bv) const;
|
|
///
|
|
bool canPaintChange(BufferView const & bv) const;
|
|
///
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
|
|
///
|
|
bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
|
|
///
|
|
ColorCode backgroundColor(PainterInfo const &) const
|
|
{ return getLayout().bgcolor(); }
|
|
///
|
|
ColorCode labelColor() const { return getLayout().labelfont().color(); }
|
|
///
|
|
InsetCode lyxCode() const { return COLLAPSABLE_CODE; }
|
|
|
|
///
|
|
virtual bool usePlainLayout() const { return true; }
|
|
///
|
|
std::string contextMenu(BufferView const & bv, int x, int y) const;
|
|
///
|
|
std::string contextMenuName() const;
|
|
protected:
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
///
|
|
void edit(Cursor & cur, bool front,
|
|
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
|
|
///
|
|
Inset * editXY(Cursor & cur, int x, int y);
|
|
///
|
|
mutable CollapseStatus status_;
|
|
private:
|
|
///
|
|
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 std::map<BufferView const *, View> view_;
|
|
};
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|