lyx_mirror/src/insets/InsetBox.cpp
Uwe Stöhr 52a158b6d7 InsetBox.cpp: add visual feedback for frame color
- the idea is to color the box inset frame according to the fame color of the box (if there is any). To keep the WYSIWYM principle the frame thickness and box separation are not taken into account. However this should be possible if anybody would like that.

- besides this, use the correct conversion command for the background color
2015-05-17 23:20:43 +02:00

832 lines
21 KiB
C++

/**
* \file InsetBox.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Martin Vermeer
* \author Jürgen Spitzmüller
* \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetBox.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
#include "ColorSet.h"
#include "Cursor.h"
#include "DispatchResult.h"
#include "FuncStatus.h"
#include "FuncRequest.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "output_xhtml.h"
#include "TextClass.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/Translator.h"
#include "frontends/Application.h"
#include <sstream>
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace {
typedef Translator<string, InsetBox::BoxType> BoxTranslator;
typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
BoxTranslator initBoxtranslator()
{
BoxTranslator translator("Boxed", InsetBox::Boxed);
translator.addPair("Frameless", InsetBox::Frameless);
translator.addPair("Framed", InsetBox::Framed);
translator.addPair("ovalbox", InsetBox::ovalbox);
translator.addPair("Ovalbox", InsetBox::Ovalbox);
translator.addPair("Shadowbox", InsetBox::Shadowbox);
translator.addPair("Shaded", InsetBox::Shaded);
translator.addPair("Doublebox",InsetBox::Doublebox);
return translator;
}
BoxTranslatorLoc initBoxtranslatorLoc()
{
BoxTranslatorLoc translator(_("simple frame"), InsetBox::Boxed);
translator.addPair(_("frameless"), InsetBox::Frameless);
translator.addPair(_("simple frame, page breaks"), InsetBox::Framed);
translator.addPair(_("oval, thin"), InsetBox::ovalbox);
translator.addPair(_("oval, thick"), InsetBox::Ovalbox);
translator.addPair(_("drop shadow"), InsetBox::Shadowbox);
translator.addPair(_("shaded background"), InsetBox::Shaded);
translator.addPair(_("double frame"), InsetBox::Doublebox);
return translator;
}
BoxTranslator const & boxtranslator()
{
static BoxTranslator const translator = initBoxtranslator();
return translator;
}
BoxTranslatorLoc const & boxtranslator_loc()
{
static BoxTranslatorLoc const translator = initBoxtranslatorLoc();
return translator;
}
} // namespace anon
/////////////////////////////////////////////////////////////////////////
//
// InsetBox
//
/////////////////////////////////////////////////////////////////////////
InsetBox::InsetBox(Buffer * buffer, string const & label)
: InsetCollapsable(buffer), params_(label)
{}
docstring InsetBox::layoutName() const
{
// FIXME: UNICODE
return from_ascii("Box:" + params_.type);
}
void InsetBox::write(ostream & os) const
{
params_.write(os);
InsetCollapsable::write(os);
}
void InsetBox::read(Lexer & lex)
{
params_.read(lex);
InsetCollapsable::read(lex);
}
void InsetBox::setButtonLabel()
{
BoxType const btype = boxtranslator().find(params_.type);
docstring const type = _("Box");
docstring inner;
if (params_.inner_box) {
if (params_.use_parbox)
inner = _("Parbox");
else if (params_.use_makebox)
inner = _("Makebox");
else
inner = _("Minipage");
}
docstring frame;
if (btype != Frameless)
frame = boxtranslator_loc().find(btype);
docstring label;
if (inner.empty() && frame.empty())
label = type;
else if (inner.empty())
label = bformat(_("%1$s (%2$s)"),
type, frame);
else if (frame.empty())
label = bformat(_("%1$s (%2$s)"),
type, inner);
else
label = bformat(_("%1$s (%2$s, %3$s)"),
type, inner, frame);
setLabel(label);
// set the frame color for the inset if the type is Boxed
if (btype == Boxed)
setFrameColor(lcolor.getFromLaTeXName(params_.framecolor));
else
setFrameColor(Color_collapsableframe);
}
bool InsetBox::hasFixedWidth() const
{
return !params_.width.empty();
}
bool InsetBox::allowMultiPar() const
{
return (params_.inner_box && !params_.use_makebox)
|| params_.type == "Shaded" || params_.type == "Framed";
}
void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
{
// back up textwidth.
int textwidth_backup = m.base.textwidth;
if (hasFixedWidth())
m.base.textwidth = params_.width.inPixels(m.base);
InsetCollapsable::metrics(m, dim);
// retore textwidth.
m.base.textwidth = textwidth_backup;
}
bool InsetBox::forcePlainLayout(idx_type) const
{
return (!params_.inner_box || params_.use_makebox)
&& params_.type != "Shaded" && params_.type != "Framed";
}
ColorCode InsetBox::backgroundColor(PainterInfo const &) const
{
// we only support background color for 3 types
if (params_.type != "Shaded" && params_.type != "Frameless" && params_.type != "Boxed")
return getLayout().bgcolor();
if (params_.type == "Shaded") {
// FIXME: This hardcoded color is a hack!
if (buffer().params().boxbgcolor == lyx::rgbFromHexName("#ff0000"))
return getLayout().bgcolor();
ColorCode c = lcolor.getFromLyXName("boxbgcolor");
if (c == Color_none)
return getLayout().bgcolor();
return c;
} else {
if (params_.backgroundcolor == "none")
return getLayout().bgcolor();
ColorCode boxbackground = lcolor.getFromLaTeXName(params_.backgroundcolor);
return boxbackground;
}
return getLayout().bgcolor();
}
void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action()) {
case LFUN_INSET_MODIFY: {
//lyxerr << "InsetBox::dispatch MODIFY" << endl;
string const first_arg = cmd.getArg(0);
bool const change_type = first_arg == "changetype";
bool const for_box = first_arg == "box";
if (!change_type && !for_box) {
// not for us
// this will not be handled higher up
cur.undispatched();
return;
}
cur.recordUndoInset(this);
if (change_type)
params_.type = cmd.getArg(1);
else // if (for_box)
string2params(to_utf8(cmd.argument()), params_);
setButtonLabel();
break;
}
default:
InsetCollapsable::doDispatch(cur, cmd);
break;
}
}
bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
switch (cmd.action()) {
case LFUN_INSET_MODIFY: {
string const first_arg = cmd.getArg(0);
if (first_arg == "changetype") {
string const type = cmd.getArg(1);
flag.setOnOff(type == params_.type);
flag.setEnabled(!params_.inner_box || type != "Framed");
return true;
}
if (first_arg == "box") {
flag.setEnabled(true);
return true;
}
return InsetCollapsable::getStatus(cur, cmd, flag);
}
case LFUN_INSET_DIALOG_UPDATE:
flag.setEnabled(true);
return true;
default:
return InsetCollapsable::getStatus(cur, cmd, flag);
}
}
const string defaultThick = "0.4pt";
const string defaultSep = "3pt";
const string defaultShadow = "4pt";
void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
{
BoxType btype = boxtranslator().find(params_.type);
string width_string = params_.width.asLatexString();
string thickness_string = params_.thickness.asLatexString();
string separation_string = params_.separation.asLatexString();
string shadowsize_string = params_.shadowsize.asLatexString();
bool stdwidth = false;
// in general the overall width of some decorated boxes is wider thean the inner box
// we could therefore calculate the real width for all sizes so that if the user wants
// e.g. 0.1\columnwidth or 2cm he gets exactly this size
// however this makes problems when importing TeX code
// therefore only recalculate for the most common case that the box should not protrude
// the page margins
if (params_.inner_box
&& ((width_string.find("1\\columnwidth") != string::npos
|| width_string.find("1\\textwidth") != string::npos)
|| width_string.find("1\\paperwidth") != string::npos
|| width_string.find("1\\linewidth") != string::npos)) {
stdwidth = true;
switch (btype) {
case Frameless:
break;
case Framed:
width_string += " - 2\\FrameSep - 2\\FrameRule";
break;
case Boxed:
width_string += " - 2\\fboxsep - 2\\fboxrule";
break;
case Shaded:
break;
case ovalbox:
width_string += " - 2\\fboxsep - 0.8pt";
break;
case Ovalbox:
width_string += " - 2\\fboxsep - 1.6pt";
break;
case Shadowbox:
width_string += " - 2\\fboxsep - 2\\fboxrule - \\shadowsize";
break;
case Doublebox:
width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
break;
}
}
os << safebreakln;
if (runparams.lastid != -1)
os.texrow().start(runparams.lastid, runparams.lastpos);
// adapt column/text width correctly also if paragraphs indented
if (stdwidth && !(buffer().params().paragraph_separation))
os << "\\noindent";
switch (btype) {
case Frameless:
break;
case Framed:
if (thickness_string != defaultThick) {
os << "{\\FrameRule " << from_ascii(thickness_string);
if (separation_string != defaultSep)
os << "\\FrameSep " << from_ascii(separation_string);
}
if (separation_string != defaultSep && thickness_string == defaultThick)
os << "{\\FrameSep " << from_ascii(separation_string);
os << "\\begin{framed}%\n";
break;
case Boxed:
if (thickness_string != defaultThick) {
os << "{\\fboxrule " << from_ascii(thickness_string);
if (separation_string != defaultSep)
os << "\\fboxsep " << from_ascii(separation_string);
}
if (separation_string != defaultSep && thickness_string == defaultThick)
os << "{\\fboxsep " << from_ascii(separation_string);
if (!params_.inner_box && !width_string.empty()) {
if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
os << "\\makebox";
} else
os << "\\framebox";
// Special widths, see usrguide sec. 3.5
// FIXME UNICODE
if (params_.special != "none") {
os << "[" << params_.width.value()
<< '\\' << from_utf8(params_.special)
<< ']';
} else
os << '[' << from_ascii(width_string)
<< ']';
if (params_.hor_pos != 'c')
os << "[" << params_.hor_pos << "]";
} else {
if (params_.framecolor != "black" || params_.backgroundcolor != "none")
os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
else
os << "\\fbox";
}
os << "{";
break;
case ovalbox:
if (!separation_string.empty() && separation_string != defaultSep)
os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\ovalbox{";
break;
case Ovalbox:
if (!separation_string.empty() && separation_string != defaultSep)
os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\Ovalbox{";
break;
case Shadowbox:
if (thickness_string != defaultThick) {
os << "{\\fboxrule " << from_ascii(thickness_string);
if (separation_string != defaultSep) {
os << "\\fboxsep " << from_ascii(separation_string);
if (shadowsize_string != defaultShadow)
os << "\\shadowsize " << from_ascii(shadowsize_string);
}
if (shadowsize_string != defaultShadow && separation_string == defaultSep)
os << "\\shadowsize " << from_ascii(shadowsize_string);
}
if (separation_string != defaultSep && thickness_string == defaultThick) {
os << "{\\fboxsep " << from_ascii(separation_string);
if (shadowsize_string != defaultShadow)
os << "\\shadowsize " << from_ascii(shadowsize_string);
}
if (shadowsize_string != defaultShadow
&& separation_string == defaultSep
&& thickness_string == defaultThick)
os << "{\\shadowsize " << from_ascii(shadowsize_string);
os << "\\shadowbox{";
break;
case Shaded:
// must be set later because e.g. the width settings only work when
// it is inside a minipage or parbox
break;
case Doublebox:
if (thickness_string != defaultThick) {
os << "{\\fboxrule " << from_ascii(thickness_string);
if (separation_string != defaultSep)
os << "\\fboxsep " << from_ascii(separation_string);
}
if (separation_string != defaultSep && thickness_string == defaultThick)
os << "{\\fboxsep " << from_ascii(separation_string);
os << "\\doublebox{";
break;
}
if (params_.inner_box) {
if (params_.use_parbox) {
if (params_.backgroundcolor != "none" && btype == Frameless)
os << "\\colorbox{" << params_.backgroundcolor << "}{";
os << "\\parbox";
} else if (params_.use_makebox) {
if (!width_string.empty()) {
if (params_.backgroundcolor != "none")
os << "\\colorbox{" << params_.backgroundcolor << "}{";
os << "\\makebox";
// FIXME UNICODE
// output the width and horizontal position
if (params_.special != "none") {
os << "[" << params_.width.value()
<< '\\' << from_utf8(params_.special)
<< ']';
} else
os << '[' << from_ascii(width_string)
<< ']';
if (params_.hor_pos != 'c')
os << "[" << params_.hor_pos << "]";
} else {
if (params_.backgroundcolor != "none")
os << "\\colorbox{" << params_.backgroundcolor << "}";
else
os << "\\mbox";
}
os << "{";
}
else {
if (params_.backgroundcolor != "none" && btype == Frameless)
os << "\\colorbox{" << params_.backgroundcolor << "}{";
os << "\\begin{minipage}";
}
// output parameters for parbox and minipage
if (!params_.use_makebox) {
os << "[" << params_.pos << "]";
if (params_.height_special == "none") {
// FIXME UNICODE
os << "[" << from_ascii(params_.height.asLatexString()) << "]";
} else {
// Special heights
// set no optional argument when the value is the default "1\height"
// (special units like \height are handled as "in")
// but when the user has chosen a non-default inner_pos, the height
// must be given: \minipage[pos][height][inner-pos]{width}
if ((params_.height != Length("1in") ||
params_.height_special != "totalheight") ||
params_.inner_pos != params_.pos) {
// FIXME UNICODE
os << "[" << params_.height.value()
<< "\\" << from_utf8(params_.height_special) << "]";
}
}
if (params_.inner_pos != params_.pos)
os << "[" << params_.inner_pos << "]";
// FIXME UNICODE
os << '{' << from_ascii(width_string) << '}';
if (params_.use_parbox)
os << "{";
}
os << "%\n";
} // end if inner_box
if (btype == Shaded) {
os << "\\begin{shaded}%\n";
}
// \framebox and \makebox handle hor_pos their own way
// hor_pos is senseless for \mbox and \fbox
if (!(params_.use_makebox)
&& !(btype == Boxed && !params_.inner_box)) {
switch (params_.hor_pos) {
case 'l':
// do nothing because this is LaTeX's default
break;
case 'c':
os << "\\centering ";
break;
case 'r':
os << "\\raggedleft ";
break;
}
}
InsetText::latex(os, runparams);
if (btype == Shaded)
os << "\\end{shaded}";
if (params_.inner_box) {
if (params_.use_parbox || params_.use_makebox)
os << "%\n}";
else
os << "%\n\\end{minipage}";
if (params_.backgroundcolor != "none" && btype == Frameless
&& !(params_.use_makebox && width_string.empty()))
os << "}";
}
switch (btype) {
case Frameless:
break;
case Framed:
os << "\\end{framed}";
if (separation_string != defaultSep || thickness_string != defaultThick)
os << "}";
break;
case Boxed:
os << "}";
if (!params_.inner_box && !width_string.empty()
&& (params_.framecolor != "black" || params_.backgroundcolor != "none"))
os << "}";
if (separation_string != defaultSep || thickness_string != defaultThick)
os << "}";
break;
case ovalbox:
os << "}";
if (separation_string != defaultSep)
os << "}";
break;
case Ovalbox:
os << "}";
if (separation_string != defaultSep)
os << "}";
break;
case Doublebox:
os << "}";
if (separation_string != defaultSep || thickness_string != defaultThick)
os << "}";
break;
case Shadowbox:
os << "}";
if (separation_string != defaultSep
|| thickness_string != defaultThick
|| shadowsize_string != defaultShadow)
os << "}";
break;
case Shaded:
// already done
break;
}
}
int InsetBox::plaintext(odocstringstream & os,
OutputParams const & runparams, size_t max_length) const
{
BoxType const btype = boxtranslator().find(params_.type);
switch (btype) {
case Frameless:
break;
case Framed:
case Boxed:
os << "[\n";
break;
case ovalbox:
os << "(\n";
break;
case Ovalbox:
os << "((\n";
break;
case Shadowbox:
case Shaded:
os << "[/\n";
break;
case Doublebox:
os << "[[\n";
break;
}
InsetText::plaintext(os, runparams, max_length);
int len = 0;
switch (btype) {
case Frameless:
os << "\n";
break;
case Framed:
case Boxed:
os << "\n]";
len = 1;
break;
case ovalbox:
os << "\n)";
len = 1;
break;
case Ovalbox:
os << "\n))";
len = 2;
break;
case Shadowbox:
case Shaded:
os << "\n/]";
len = 2;
break;
case Doublebox:
os << "\n]]";
len = 2;
break;
}
return PLAINTEXT_NEWLINE + len; // len chars on a separate line
}
int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
{
return InsetText::docbook(os, runparams);
}
docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
{
// construct attributes
string attrs = "class='" + params_.type + "'";
string style;
if (!params_.width.empty()) {
string w = params_.width.asHTMLString();
if (w != "100%")
style += ("width: " + params_.width.asHTMLString() + "; ");
}
// The special heights don't really mean anything for us.
if (!params_.height.empty() && params_.height_special == "none")
style += ("height: " + params_.height.asHTMLString() + "; ");
if (!style.empty())
attrs += " style='" + style + "'";
xs << html::StartTag("div", attrs);
XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
xs << html::EndTag("div");
xs << defer;
return docstring();
}
void InsetBox::validate(LaTeXFeatures & features) const
{
BoxType btype = boxtranslator().find(params_.type);
switch (btype) {
case Frameless:
if (params_.backgroundcolor != "none")
features.require("xcolor");
break;
case Framed:
features.require("calc");
features.require("framed");
break;
case Boxed:
features.require("calc");
if (params_.framecolor != "black" || params_.backgroundcolor != "none")
features.require("xcolor");
break;
case ovalbox:
case Ovalbox:
case Shadowbox:
case Doublebox:
features.require("calc");
features.require("fancybox");
break;
case Shaded:
features.require("color");
features.require("framed");
break;
}
InsetCollapsable::validate(features);
}
string InsetBox::contextMenuName() const
{
return "context-box";
}
string InsetBox::params2string(InsetBoxParams const & params)
{
ostringstream data;
data << "box" << ' ';
params.write(data);
return data.str();
}
void InsetBox::string2params(string const & in, InsetBoxParams & params)
{
if (in.empty())
return;
istringstream data(in);
Lexer lex;
lex.setStream(data);
string name;
lex >> name;
if (!lex || name != "box") {
LYXERR0("InsetBox::string2params(" << in << ")\n"
"Expected arg 1 to be \"box\"\n");
return;
}
// This is part of the inset proper that is usually swallowed
// by Text::readInset
string id;
lex >> id;
if (!lex || id != "Box") {
LYXERR0("InsetBox::string2params(" << in << ")\n"
"Expected arg 2 to be \"Box\"\n");
}
params = InsetBoxParams(string());
params.read(lex);
}
/////////////////////////////////////////////////////////////////////////
//
// InsetBoxParams
//
/////////////////////////////////////////////////////////////////////////
InsetBoxParams::InsetBoxParams(string const & label)
: type(label),
use_parbox(false),
use_makebox(false),
inner_box(true),
width(Length("100col%")),
special("none"),
pos('t'),
hor_pos('c'),
inner_pos('t'),
height(Length("1in")),
height_special("totalheight"), // default is 1\\totalheight
thickness(Length(defaultThick)),
separation(Length(defaultSep)),
shadowsize(Length(defaultShadow)),
framecolor("black"),
backgroundcolor("none")
{}
void InsetBoxParams::write(ostream & os) const
{
os << "Box " << type << "\n";
os << "position \"" << pos << "\"\n";
os << "hor_pos \"" << hor_pos << "\"\n";
os << "has_inner_box " << inner_box << "\n";
os << "inner_pos \"" << inner_pos << "\"\n";
os << "use_parbox " << use_parbox << "\n";
os << "use_makebox " << use_makebox << "\n";
os << "width \"" << width.asString() << "\"\n";
os << "special \"" << special << "\"\n";
os << "height \"" << height.asString() << "\"\n";
os << "height_special \"" << height_special << "\"\n";
os << "thickness \"" << thickness.asString() << "\"\n";
os << "separation \"" << separation.asString() << "\"\n";
os << "shadowsize \"" << shadowsize.asString() << "\"\n";
os << "framecolor \"" << framecolor << "\"\n";
os << "backgroundcolor \"" << backgroundcolor << "\"\n";
}
void InsetBoxParams::read(Lexer & lex)
{
lex.setContext("InsetBoxParams::read");
lex >> type;
lex >> "position" >> pos;
lex >> "hor_pos" >> hor_pos;
lex >> "has_inner_box" >> inner_box;
if (type == "Framed")
inner_box = false;
lex >> "inner_pos" >> inner_pos;
lex >> "use_parbox" >> use_parbox;
lex >> "use_makebox" >> use_makebox;
lex >> "width" >> width;
lex >> "special" >> special;
lex >> "height" >> height;
lex >> "height_special" >> height_special;
lex >> "thickness" >> thickness;
lex >> "separation" >> separation;
lex >> "shadowsize" >> shadowsize;
lex >> "framecolor" >> framecolor;
lex >> "backgroundcolor" >> backgroundcolor;
}
} // namespace lyx