lyx_mirror/src/insets/InsetCollapsable.h
Abdelrazak Younes 2640b21228 * Inset and derivatives: insetName() -> name()
* InsetMath::name(): deleted.

* buffer_funcs.cpp:setCaptions() fix potential bug by using docstring copy instead of reference while using Inset::name.





git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18119 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-30 14:39:09 +00:00

136 lines
3.1 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 "Inset.h"
#include "InsetText.h"
#include "Box.h"
#include "Font.h"
#include <string>
namespace lyx {
class Text;
class Paragraph;
class CursorSlice;
namespace frontend { class Painter; }
/** A collapsable text inset
*/
class InsetCollapsable : public InsetText {
public:
///
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);
///
docstring name() const { return from_ascii("Collapsable"); }
///
void read(Buffer const &, Lexer &);
///
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(Font & 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(Cursor &, FuncRequest const &, FuncStatus &) const;
///
void setStatus(Cursor & cur, CollapseStatus st);
///
bool setMouseHover(bool mouse_hover);
protected:
///
virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
///
Dimension dimensionCollapsed() const;
///
Box const & buttonDim() const;
///
void edit(Cursor & cur, bool left);
///
Inset * editXY(Cursor & cur, int x, int y);
///
void setInlined() { status_ = Inlined; }
///
docstring floatName(std::string const & type, BufferParams const &) const;
protected:
///
Font labelfont_;
///
mutable Box button_dim;
///
mutable int topx;
///
mutable int topbaseline;
///
mutable docstring label;
private:
///
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(Cursor & cur, Inset const & in);
} // namespace lyx
#endif