lyx_mirror/src/insets/insetcollapsable.h
André Pönitz 41ecabf519 make boundary property an iterator property instead of a CursorSlice property
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@10214 a592a061-630c-0410-9148-cb99ea01b6c8
2005-07-15 15:49:40 +00:00

123 lines
2.8 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 "lyxfont.h"
class Painter;
class LyXText;
class Paragraph;
class CursorSlice;
/** 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);
///
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;
///
void drawSelection(PainterInfo & pi, int x, int y) const;
/// return x,y of given position relative to the inset's baseline
void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
///
bool hitButton(FuncRequest const &) const;
///
std::string const getNewLabel(std::string const & l) const;
///
EDITABLE editable() const;
/// can we go further down on mouse click?
bool descendable() const;
///
bool isTextInset() const { return true; }
///
void setLabel(std::string const & l);
///
virtual void setButtonLabel() {}
///
void setLabelFont(LyXFont & f);
///
int scroll(bool recursive = true) const;
///
bool isOpen() const { return status_ == Open || status_ == Inlined; }
///
bool inlined() const { return status_ == Inlined; }
///
CollapseStatus status() const { return status_; }
///
bool allowSpellCheck() const { return true; }
///
bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
///
void setStatus(LCursor & cur, CollapseStatus st);
protected:
///
virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
///
Dimension dimensionCollapsed() const;
///
int getMaxTextWidth(Painter & pain, UpdatableInset const *) const;
///
Box const & buttonDim() const;
///
void edit(LCursor & cur, bool left);
///
InsetBase * editXY(LCursor & cur, int x, int y);
///
void setInlined() { status_ = Inlined; }
protected:
///
LyXFont labelfont_;
///
mutable Box button_dim;
///
mutable int topx;
///
mutable int topbaseline;
///
mutable std::string label;
private:
///
mutable CollapseStatus status_;
/// a substatus of the Open status, determined automatically in metrics
mutable bool openinlined_;
///
mutable Dimension textdim_;
};
// A helper function that pushes the cursor out of the inset.
void leaveInset(LCursor & cur, InsetBase const & in);
#endif