lyx_mirror/src/insets/InsetFloatList.cpp

160 lines
3.5 KiB
C++
Raw Normal View History

/**
* \file InsetFloatList.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetFloatList.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "DispatchResult.h"
#include "Floating.h"
#include "FloatList.h"
#include "FuncRequest.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "TocBackend.h"
#include "TextClass.h"
#include "support/debug.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include <ostream>
using namespace std;
using namespace lyx::support;
namespace lyx {
InsetFloatList::InsetFloatList()
: InsetCommand(InsetCommandParams(FLOAT_LIST_CODE), "toc")
{}
InsetFloatList::InsetFloatList(string const & type)
: InsetCommand(InsetCommandParams(FLOAT_LIST_CODE), "toc")
{
setParam("type", from_ascii(type));
}
ParamInfo const & InsetFloatList::findInfo(string const & /* cmdName */)
{
static ParamInfo param_info_;
if (param_info_.empty()) {
Per Abdel's suggestion that we focus on bug-fixing at this point, this will be the last patch in this series for a bit. But I wanted to get this done before I forget what it is I was doing, so here it is. The idea behind this patch is to make real key-value support for InsetCommand parameters possible. This should be particularly useful for the listings version of InsetInclude, though we would need some kind of UI for it before it would really be helpful. (See below for some thoughts.) This doesn't substantially change anything else, though some things do get re-arranged a bit. Basically, the idea is this. First, we introduce a whole range of parameter types: Normal LaTeX optional and required parameters; ones for LyX's internal use (like embed); and finally, in connection with keyval, ones that represent keys and ones that represent optional and required arguments where the keyval stuff will appear. (I'm assuming here that there will always be exactly one of those, and that it will accept only keyval-type material.) The parameters themselves are stored in a map, so it's really only the output routines that need to care about the different types of parameters. Regarding the frontend, it seems to me that something like the following would work: (i) scan the parameter list for LATEX_KEY type parameters (ii) the dialog will have a series of lines, each of which has a combo box listing the acceptable keys and a QLineEdit for entering its value, as well as a "delete" button of some sort for removing this key and its value (iii) there should be an "add line" button to add a new line, activated only when all other lines are filled with values Probably not even too hard. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23235 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-25 22:13:45 +00:00
param_info_.add("type", ParamInfo::LATEX_REQUIRED);
}
return param_info_;
}
//HACK
bool InsetFloatList::isCompatibleCommand(string const & s)
{
string str = s.substr(0, 6);
return str == "listof";
}
docstring InsetFloatList::screenLabel() const
{
FloatList const & floats = buffer().params().documentClass().floats();
FloatList::const_iterator it = floats[to_ascii(getParam("type"))];
if (it != floats.end())
return buffer().B_(it->second.listName());
else
return _("ERROR: Nonexistent float type!");
}
void InsetFloatList::write(ostream & os) const
{
os << "FloatList " << to_ascii(getParam("type")) << "\n";
}
void InsetFloatList::read(Lexer & lex)
{
lex.setContext("InsetFloatList::read");
FloatList const & floats = buffer().params().documentClass().floats();
string token;
if (lex.eatLine()) {
setParam("type", lex.getDocString());
LYXERR(Debug::INSETS, "FloatList::float_type: "
<< to_ascii(getParam("type")));
if (!floats.typeExist(to_ascii(getParam("type"))))
lex.printError("Unknown float type");
} else {
lex.printError("Parse error");
}
while (lex.isOK()) {
lex.next();
token = lex.getString();
if (token == "\\end_inset")
break;
}
if (token != "\\end_inset") {
lex.printError("Missing \\end_inset at this point.");
}
}
int InsetFloatList::latex(odocstream & os, OutputParams const &) const
{
FloatList const & floats = buffer().params().documentClass().floats();
FloatList::const_iterator cit = floats[to_ascii(getParam("type"))];
if (cit != floats.end()) {
if (cit->second.builtin()) {
// Only two different types allowed here:
string const type = cit->second.type();
if (type == "table") {
os << "\\listoftables\n";
} else if (type == "figure") {
os << "\\listoffigures\n";
} else {
os << "%% unknown builtin float\n";
}
} else {
os << "\\listof{" << getParam("type") << "}{"
<< buffer().B_(cit->second.listName()) << "}\n";
}
} else {
os << "%%\\listof{" << getParam("type") << "}{"
<< bformat(_("List of %1$s"), from_utf8(cit->second.name()))
<< "}\n";
}
return 1;
}
int InsetFloatList::plaintext(odocstream & os, OutputParams const &) const
{
os << screenLabel() << "\n\n";
buffer().tocBackend().writePlaintextTocList(to_ascii(getParam("type")), os);
return PLAINTEXT_NEWLINE;
}
void InsetFloatList::validate(LaTeXFeatures & features) const
{
features.useFloat(to_ascii(getParam("type")));
}
} // namespace lyx