lyx_mirror/src/insets/InsetBox.cpp

869 lines
22 KiB
C++
Raw Normal View History

/**
* \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"
Fix bug 4037 and related problems. The patch has been cleaned up a bit from the one posted to the list. The basic idea has two parts. First, we hard code an "empty layout" (called PlainLayout, for want of a better name) in TextClass and read it before doing anything else. It can therefore be customized by classes, if they want---say, to make it left-aligned. Second, InsetText's are divided into three types: (i) normal ones, that use the "default" layout defined by the text class; (ii) highly restrictive ones, such as ERT and (not quite an inset) table cells, which demand the empty layout; (iii) middling ones, which default to an empty layout and use the empty layout in place of the default. (This is so we don't get the same problem we had with ERT in e.g. footnotes.) The type of inset is signaled by new methods InsetText::forceEmptyLayout() and InsetText::useEmptyLayout(). (The latter might better be called: useEmptyLayoutInsteadOfDefault(), but that's silly.) The old InsetText::forceDefaultParagraphs() has been split into these, plus a new method InsetText::allowParagraphCustomization(). A lot of the changes just adapt to this change. The other big change is in GuiToolbar: We want to show LyXDefault and the "default" layout only when they're active. There are a handful of places where I'm not entirely sure whether we should be using forceEmptyLayout or !allowParagraphCustomization() or both. The InsetCaption is one of these. These places, and some others, are marked with FIXMEs, so I'd appreciate it if people would search through the patch and let me know whether these need changing. If they don't, the FIXMEs can be deleted. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22966 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-12 17:31:07 +00:00
#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 "TexRow.h"
#include "texstream.h"
Fix bug 4037 and related problems. The patch has been cleaned up a bit from the one posted to the list. The basic idea has two parts. First, we hard code an "empty layout" (called PlainLayout, for want of a better name) in TextClass and read it before doing anything else. It can therefore be customized by classes, if they want---say, to make it left-aligned. Second, InsetText's are divided into three types: (i) normal ones, that use the "default" layout defined by the text class; (ii) highly restrictive ones, such as ERT and (not quite an inset) table cells, which demand the empty layout; (iii) middling ones, which default to an empty layout and use the empty layout in place of the default. (This is so we don't get the same problem we had with ERT in e.g. footnotes.) The type of inset is signaled by new methods InsetText::forceEmptyLayout() and InsetText::useEmptyLayout(). (The latter might better be called: useEmptyLayoutInsteadOfDefault(), but that's silly.) The old InsetText::forceDefaultParagraphs() has been split into these, plus a new method InsetText::allowParagraphCustomization(). A lot of the changes just adapt to this change. The other big change is in GuiToolbar: We want to show LyXDefault and the "default" layout only when they're active. There are a handful of places where I'm not entirely sure whether we should be using forceEmptyLayout or !allowParagraphCustomization() or both. The InsetCaption is one of these. These places, and some others, are marked with FIXMEs, so I'd appreciate it if people would search through the patch and let me know whether these need changing. If they don't, the FIXMEs can be deleted. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22966 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-12 17:31:07 +00:00
#include "TextClass.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/gettext.h"
#include "support/lstrings.h"
Rename files in src/support, step one. src/support/package.h src/support/Package.h Package src/support/package.C.in src/support/Package.C.in Package src/support/path.h src/support/Path.h Path src/support/fs_extras.h src/support/fs_extras.h NOCLASSES src/support/RandomAccessList.h src/support/RandomAccessList.h RandomAccessList src/support/lyxmanip.h src/support/lyxmanip.h NOCLASSES src/support/rename.C src/support/rename.cpp NOCLASSES src/support/abort.C src/support/abort.cpp NOCLASSES src/support/lyxlib.h src/support/lyxlib.h NOCLASSES src/support/ExceptionMessage.h src/support/ExceptionMessage.h ExceptionMessage src/support/copy.C src/support/copy.cpp NOCLASSES src/support/limited_stack.h src/support/limited_stack.h limited_stack src/support/filefilterlist.C src/support/FileFilterList.cpp ['FileFilterList', 'Filter'] src/support/cow_ptr.h src/support/cow_ptr.h cow_ptr src/support/os_unix.C src/support/os_unix.cpp NOCLASSES src/support/socktools.h src/support/socktools.h NOCLASSES src/support/forkedcontr.h src/support/ForkedcallsController.h ForkedcallsController src/support/os.h src/support/os.h NOCLASSES src/support/FileMonitor.h src/support/FileMonitor.h FileMonitor src/support/copied_ptr.h src/support/copied_ptr.h copied_ptr src/support/translator.h src/support/Translator.h Translator src/support/filetools.C src/support/filetools.cpp NOCLASSES src/support/unlink.C src/support/unlink.cpp NOCLASSES src/support/os_win32.C src/support/os_win32.cpp GetFolderPath src/support/lstrings.C src/support/lstrings.cpp NOCLASSES src/support/qstring_helpers.C src/support/qstring_helpers.cpp NOCLASSES src/support/getcwd.C src/support/getcwd.cpp NOCLASSES src/support/systemcall.C src/support/Systemcall.cpp Systemcall src/support/lyxalgo.h src/support/lyxalgo.h NOCLASSES src/support/filefilterlist.h src/support/FileFilterList.h ['FileFilterList', 'Filter'] src/support/unicode.C src/support/unicode.cpp IconvProcessor src/support/userinfo.C src/support/userinfo.cpp NOCLASSES src/support/lyxtime.C src/support/lyxtime.cpp NOCLASSES src/support/kill.C src/support/kill.cpp NOCLASSES src/support/docstring.C src/support/docstring.cpp to_local8bit_failure src/support/os_cygwin.C src/support/os_cygwin.cpp NOCLASSES src/support/lyxsum.C src/support/lyxsum.cpp NOCLASSES src/support/environment.C src/support/environment.cpp NOCLASSES src/support/filetools.h src/support/filetools.h NOCLASSES src/support/textutils.C src/support/textutils.cpp NOCLASSES src/support/mkdir.C src/support/mkdir.cpp NOCLASSES src/support/forkedcall.C src/support/Forkedcall.cpp ['ForkedProcess', 'Forkedcall'] src/support/tempname.C src/support/tempname.cpp NOCLASSES src/support/os_win32.h src/support/os_win32.h GetFolderPath src/support/types.h src/support/types.h NOCLASSES src/support/lstrings.h src/support/lstrings.h NOCLASSES src/support/forkedcallqueue.C src/support/ForkedCallQueue.cpp ForkedCallQueue src/support/qstring_helpers.h src/support/qstring_helpers.h NOCLASSES src/support/convert.C src/support/convert.cpp NOCLASSES src/support/filename.C src/support/FileName.cpp ['FileName', 'DocFileName'] src/support/tests/convert.C src/support/tests/convert.cpp NOCLASSES src/support/tests/filetools.C src/support/tests/filetools.cpp NOCLASSES src/support/tests/lstrings.C src/support/tests/lstrings.cpp NOCLASSES src/support/tests/boost.C src/support/tests/boost.cpp NOCLASSES src/support/docstream.C src/support/docstream.cpp ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/std_istream.h src/support/std_istream.h NOCLASSES src/support/systemcall.h src/support/Systemcall.h Systemcall src/support/chdir.C src/support/chdir.cpp NOCLASSES src/support/std_ostream.h src/support/std_ostream.h NOCLASSES src/support/unicode.h src/support/unicode.h IconvProcessor src/support/path.C src/support/Path.cpp Path src/support/fs_extras.C src/support/fs_extras.cpp NOCLASSES src/support/userinfo.h src/support/userinfo.h NOCLASSES src/support/lyxtime.h src/support/lyxtime.h NOCLASSES src/support/docstring.h src/support/docstring.h to_local8bit_failure src/support/debugstream.h src/support/debugstream.h basic_debugstream src/support/environment.h src/support/environment.h NOCLASSES src/support/textutils.h src/support/textutils.h NOCLASSES src/support/forkedcall.h src/support/Forkedcall.h ['ForkedProcess', 'Forkedcall'] src/support/socktools.C src/support/socktools.cpp NOCLASSES src/support/forkedcallqueue.h src/support/ForkedCallQueue.h ForkedCallQueue src/support/forkedcontr.C src/support/ForkedcallsController.cpp ForkedcallsController src/support/os.C src/support/os.cpp NOCLASSES src/support/convert.h src/support/convert.h NOCLASSES src/support/filename.h src/support/FileName.h ['FileName', 'DocFileName'] src/support/docstream.h src/support/docstream.h ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/FileMonitor.C src/support/FileMonitor.cpp FileMonitor git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18024 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-26 05:12:52 +00:00
#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;
}
Bulk cleanup/fix incorrect annotation at the end of namespaces. This commit does a bulk fix of incorrect annotations (comments) at the end of namespaces. The commit was generated by initially running clang-format, and then from the diff of the result extracting the hunks corresponding to fixes of namespace comments. The changes being applied and all the results have been manually reviewed. The source code successfully builds on macOS. Further details on the steps below, in case they're of interest to someone else in the future. 1. Checkout a fresh and up to date version of src/ git pull && git checkout -- src && git status src 2. Ensure there's a suitable .clang-format in place, i.e. with options to fix the comment at the end of namespaces, including: FixNamespaceComments: true SpacesBeforeTrailingComments: 1 and that clang-format is >= 5.0.0, by doing e.g.: clang-format -dump-config | grep Comments: clang-format --version 3. Apply clang-format to the source: clang-format -i $(find src -name "*.cpp" -or -name "*.h") 4. Create and filter out hunks related to fixing the namespace git diff -U0 src > tmp.patch grepdiff '^} // namespace' --output-matching=hunk tmp.patch > fix_namespace.patch 5. Filter out hunks corresponding to simple fixes into to a separate patch: pcregrep -M -e '^diff[^\n]+\nindex[^\n]+\n--- [^\n]+\n\+\+\+ [^\n]+\n' \ -e '^@@ -[0-9]+ \+[0-9]+ @@[^\n]*\n-\}[^\n]*\n\+\}[^\n]*\n' \ fix_namespace.patch > fix_namespace_simple.patch 6. Manually review the simple patch and then apply it, after first restoring the source. git checkout -- src patch -p1 < fix_namespace_simple.path 7. Manually review the (simple) changes and then stage the changes git diff src git add src 8. Again apply clang-format and filter out hunks related to any remaining fixes to the namespace, this time filter with more context. There will be fewer hunks as all the simple cases have already been handled: clang-format -i $(find src -name "*.cpp" -or -name "*.h") git diff src > tmp.patch grepdiff '^} // namespace' --output-matching=hunk tmp.patch > fix_namespace2.patch 9. Manually review/edit the resulting patch file to remove hunks for files which need to be dealt with manually, noting the file names and line numbers. Then restore files to as before applying clang-format and apply the patch: git checkout src patch -p1 < fix_namespace2.patch 10. Manually fix the files noted in the previous step. Stage files, review changes and commit.
2017-07-23 11:11:54 +00:00
} // namespace
/////////////////////////////////////////////////////////////////////////
//
// InsetBox
//
/////////////////////////////////////////////////////////////////////////
InsetBox::InsetBox(Buffer * buffer, string const & label)
: InsetCollapsible(buffer), params_(label)
{}
docstring InsetBox::layoutName() const
{
// FIXME: UNICODE
return from_ascii("Box:" + params_.type);
}
void InsetBox::write(ostream & os) const
{
params_.write(os);
InsetCollapsible::write(os);
}
void InsetBox::read(Lexer & lex)
{
params_.read(lex);
InsetCollapsible::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_collapsibleframe);
}
bool InsetBox::hasFixedWidth() const
{
return !params_.width.empty() && params_.special == "none";
}
bool InsetBox::allowMultiPar() const
{
return (params_.inner_box && !params_.use_makebox)
|| params_.type == "Shaded" || params_.type == "Framed";
}
void InsetBox::metrics(MetricsInfo & mi, Dimension & dim) const
{
// back up textwidth.
int textwidth_backup = mi.base.textwidth;
if (hasFixedWidth())
mi.base.textwidth = mi.base.inPixels(params_.width);
InsetCollapsible::metrics(mi, dim);
// retore textwidth.
mi.base.textwidth = textwidth_backup;
}
bool InsetBox::forcePlainLayout(idx_type) const
{
return (!params_.inner_box || params_.use_makebox)
&& params_.type != "Shaded" && params_.type != "Framed";
}
bool InsetBox::needsCProtection(bool const maintext, bool const fragile) const
{
// We need to cprotect boxes that use minipages as inner box
// in fragile context
if (fragile && params_.inner_box && !params_.use_parbox && !params_.use_makebox)
return true;
return InsetText::needsCProtection(maintext, fragile);
}
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;
}
if (params_.backgroundcolor != "none")
return lcolor.getFromLaTeXName(params_.backgroundcolor);
return getLayout().bgcolor();
}
LyXAlignment InsetBox::contentAlignment() const
{
// Custom horizontal alignment is only allowed with a fixed width
// and if either makebox or no inner box are used
if (params_.width.empty() || !(params_.use_makebox || !params_.inner_box))
return LYX_ALIGN_NONE;
// The default value below is actually irrelevant
LyXAlignment align = LYX_ALIGN_NONE;
switch (params_.hor_pos) {
case 'l':
align = LYX_ALIGN_LEFT;
break;
case 'c':
align = LYX_ALIGN_CENTER;
break;
case 'r':
align = LYX_ALIGN_RIGHT;
break;
case 's':
align = LYX_ALIGN_BLOCK;
break;
}
return align;
}
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);
2016-02-04 23:49:17 +00:00
if (change_type) {
params_.type = cmd.getArg(1);
2016-02-04 23:49:17 +00:00
// set a makebox if there is no inner box but Frameless was exectued
// otherwise the result would be a non existent box (no inner AND outer box)
// (this was LyX bug 8712)
if (params_.type == "Frameless" && !params_.inner_box) {
params_.use_makebox = true;
params_.inner_box = true;
}
// handle the opposite case
if (params_.type == "Boxed" && params_.use_makebox) {
params_.use_makebox = false;
params_.inner_box = false;
}
} else
string2params(to_utf8(cmd.argument()), params_);
setButtonLabel();
break;
}
default:
InsetCollapsible::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 InsetCollapsible::getStatus(cur, cmd, flag);
}
case LFUN_INSET_DIALOG_UPDATE:
flag.setEnabled(true);
return true;
default:
return InsetCollapsible::getStatus(cur, cmd, flag);
}
}
2015-05-13 07:15:37 +00:00
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;
string const cprotect = hasCProtectContent(runparams.moving_arg) ? "\\cprotect" : string();
// 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);
2015-05-15 01:59:04 +00:00
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";
2015-05-15 01:59:04 +00:00
// Special widths, see usrguide sec. 3.5
// FIXME UNICODE
if (params_.special != "none") {
os << "[" << params_.width.value()
<< '\\' << from_utf8(params_.special)
<< ']';
} else
2015-05-15 01:59:04 +00:00
os << '[' << from_ascii(width_string)
<< ']';
// default horizontal alignment is 'c'
2015-05-15 01:59:04 +00:00
if (params_.hor_pos != 'c')
os << "[" << params_.hor_pos << "]";
} else {
if (params_.framecolor != "black" || params_.backgroundcolor != "none")
os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
else
2018-04-14 10:57:44 +00:00
os << cprotect << "\\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";
}
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;
}
InsetCollapsible::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
2015-05-13 07:15:37 +00:00
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