lyx_mirror/src/insets/insetcollapsable.C

/**
 * \file insetcollapsable.C
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Alejandro Aguilar Sierra
 * \author J<EFBFBD>rgen Vigna
 * \author Lars Gullik Bj<EFBFBD>nnes
 *
 * Full author contact details are available in file CREDITS.
 */

#include <config.h>

#include "insetcollapsable.h"

#include "buffer.h"
#include "BufferView.h"
#include "cursor.h"
#include "debug.h"
#include "dispatchresult.h"
#include "LColor.h"
#include "lyxlex.h"
#include "funcrequest.h"
#include "metricsinfo.h"
#include "paragraph.h"

#include "frontends/font_metrics.h"
#include "frontends/Painter.h"
#include "frontends/LyXView.h"


using lyx::graphics::PreviewLoader;

using std::endl;
using std::string;
using std::max;
using std::min;
using std::ostream;


void getOutOfInset(LCursor & cur, InsetBase const & in)
{
	for (unsigned int i = 0; i != cur.size(); ++i) {
		if (&cur[i].inset() == &in) {
			cur.resize(i);
			return;
		}
	}
}


InsetCollapsable::InsetCollapsable(BufferParams const & bp,
	CollapseStatus status)
	: InsetText(bp), label("Label"), status_(status), openinlined_(false)
{
	setAutoBreakRows(true);
	setDrawFrame(InsetText::ALWAYS);
	setFrameColor(LColor::collapsableframe);
	setInsetName("Collapsable");
	setButtonLabel();
}


void InsetCollapsable::write(Buffer const & buf, ostream & os) const
{
	os << "status ";
	switch (status_) {
	case Open:
		os << "open";
		break;
	case Collapsed:
		os << "collapsed";
		break;
	case Inlined:
		os << "inlined";
		break;
	}
	os << "\n";
	text_.write(buf, os);
}


void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
{
	bool token_found = false;
	if (lex.isOK()) {
		lex.next();
		string const token = lex.getString();
		if (token == "status") {
			lex.next();
			string const tmp_token = lex.getString();

			if (tmp_token == "inlined") {
				status_ = Inlined;
				token_found = true;
			} else if (tmp_token == "collapsed") {
				status_ = Collapsed;
				token_found = true;
			} else if (tmp_token == "open") {
				status_ = Open;
				token_found = true;
			} else {
				lyxerr << "InsetCollapsable::read: Missing status!"
				       << endl;
				// Take countermeasures
				lex.pushToken(token);
			}
		} else {
			lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
				   << endl;
			// take countermeasures
			lex.pushToken(token);
		}
	}
	InsetText::read(buf, lex);

	if (!token_found)
		status_ = isOpen() ? Open : Collapsed;

	setButtonLabel();
}


void InsetCollapsable::dimension_collapsed(Dimension & dim) const
{
	font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
}


void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
{
	mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
	if (status_ == Inlined) {
		InsetText::metrics(mi, dim);
	} else {
		dimension_collapsed(dim);
		if (status_ == Open) {
			InsetText::metrics(mi, textdim_);
			openinlined_ = (textdim_.wid + dim.wid <= mi.base.textwidth);
			if (openinlined_) {
				dim.wid += textdim_.wid;
				dim.des = max(dim.des, textdim_.des);
				dim.asc = max(dim.asc, textdim_.asc);
			} else {
				dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
				dim.wid = max(dim.wid, textdim_.wid);
			}
		}
	}
	dim.asc += TEXT_TO_INSET_OFFSET;
	dim.des += TEXT_TO_INSET_OFFSET;
	dim.wid += 2 * TEXT_TO_INSET_OFFSET;
	mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
	dim_ = dim;
}


void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
{
	pi.pain.buttonText(x, y, label, labelfont_);
}


void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
{
	x += TEXT_TO_INSET_OFFSET;
	y += TEXT_TO_INSET_OFFSET;

	if (status_ == Inlined) {
		InsetText::draw(pi, x, y);
	} else {
		Dimension dimc;
		dimension_collapsed(dimc);
		int const aa  = ascent();
		button_dim.x1 = x + 0;
		button_dim.x2 = x + dimc.width();
		button_dim.y1 = y - aa + pi.base.bv->top_y();
		button_dim.y2 = y - aa + pi.base.bv->top_y() + dimc.height();

		draw_collapsed(pi, x, y - aa + dimc.asc);
		if (status_ == Open) {
			if (openinlined_)
				InsetText::draw(pi, x + dimc.width(),
						y - aa + textdim_.asc);
			else 
				InsetText::draw(pi, x, dimc.height()
						+ y - aa + textdim_.asc);
		}
	}
	setPosCache(pi, x, y);
}


InsetOld::EDITABLE InsetCollapsable::editable() const
{
	return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
}


bool InsetCollapsable::descendable() const
{
	return status_ != Collapsed;
}


bool InsetCollapsable::hitButton(FuncRequest & cmd) const
{
	return button_dim.contains(cmd.x, cmd.y);
}


string const InsetCollapsable::getNewLabel(string const & l) const
{
	string label;
	pos_type const max_length = 15;
	pos_type const p_siz = paragraphs().begin()->size();
	pos_type const n = min(max_length, p_siz);
	pos_type i = 0;
	pos_type j = 0;
	for( ; i < n && j < p_siz; ++j) {
		if (paragraphs().begin()->isInset(j))
			continue;
		label += paragraphs().begin()->getChar(j);
		++i;
	}
	if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
		label += "...";
	}
	return label.empty() ? l : label;
}


void InsetCollapsable::edit(LCursor & cur, bool left)
{
	//lyxerr << "InsetCollapsable: edit left/right" << endl;
	cur.push(*this);
	InsetText::edit(cur, left);
	open();
}


InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
{
	cur.push(*this);
	//lyxerr << "InsetCollapsable: edit xy" << endl;
	if (status_ == Collapsed) {
		setStatus(Open);
		// We are not calling editXY() because the row cache of the
		// inset might be invalid. 'Entering from the left' should be
		// ok, though.
		InsetText::edit(cur, true);
		return this;
	}
	return InsetText::editXY(cur, x, y);
}


void InsetCollapsable::priv_dispatch(LCursor & cur, FuncRequest & cmd)
{
	//lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
	//	<< "  button y: " << button_dim.y2 << endl;
	switch (cmd.action) {
	case LFUN_MOUSE_PRESS:
		if (status_ == Inlined)
			InsetText::priv_dispatch(cur, cmd);
		else if (status_ == Open && !hitButton(cmd))
			InsetText::priv_dispatch(cur, cmd);
		break;

	case LFUN_MOUSE_MOTION:
		if (status_ == Inlined)
			InsetText::priv_dispatch(cur, cmd);
		else if (status_ == Open && !hitButton(cmd))
			InsetText::priv_dispatch(cur, cmd);
		break;

	case LFUN_MOUSE_RELEASE:
		if (cmd.button() == mouse_button::button3) {
			showInsetDialog(&cur.bv());
			break;
		}

		switch (status_) {

		case Collapsed:
			lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
			setStatus(Open);
			edit(cur, true);
			break;

		case Open: {
			FuncRequest cmd1 = cmd;
			if (hitButton(cmd1)) {
				lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
				setStatus(Collapsed);
				cur.undispatched();
				cmd = FuncRequest(LFUN_FINISHED_RIGHT);
			} else {
				lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
				InsetText::priv_dispatch(cur, cmd);
			}
			break;
		}

		case Inlined:
			lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
			InsetText::priv_dispatch(cur, cmd);
			break;
		}
		break;

	case LFUN_INSET_TOGGLE:
		if (cmd.argument == "open")
			setStatus(Open);
		else if (cmd.argument == "close") {
			setStatus(Collapsed);
			getOutOfInset(cur, *this);
		} else if (cmd.argument == "toggle"
			   || cmd.argument.empty()) {
			if (isOpen()) {
				setStatus(Collapsed);
				getOutOfInset(cur, *this);
			} else
				setStatus(Open);
		}
		cur.dispatched();
		break;

	default:
		InsetText::priv_dispatch(cur, cmd);
		break;
	}
}


int InsetCollapsable::scroll(bool recursive) const
{
	int sx = UpdatableInset::scroll(false);

	if (recursive)
		sx += InsetText::scroll(false);

	return sx;
}


void InsetCollapsable::open()
{
	if (status_ == Collapsed)   // ...but not inlined
		setStatus(Open);
}


void InsetCollapsable::close()
{
	setStatus(Collapsed);
}


void InsetCollapsable::setLabel(string const & l)
{
	label = l;
}


void InsetCollapsable::setStatus(CollapseStatus st)
{
	status_ = st;
	setButtonLabel();
}


void InsetCollapsable::setLabelFont(LyXFont & font)
{
	labelfont_ = font;
}


void InsetCollapsable::scroll(BufferView & bv, float sx) const
{
	UpdatableInset::scroll(bv, sx);
}


void InsetCollapsable::scroll(BufferView & bv, int offset) const
{
	UpdatableInset::scroll(bv, offset);
}


Box const & InsetCollapsable::buttonDim() const
{
	return button_dim;
}