* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author O. U. Baran
+ * \author Uwe Stöhr
+ * \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include "Buffer.h"
#include "DispatchResult.h"
+#include "Font.h"
#include "FuncRequest.h"
-#include "support/gettext.h"
+#include "FuncStatus.h"
#include "InsetIterator.h"
+#include "InsetList.h"
#include "LaTeXFeatures.h"
+#include "Length.h"
+#include "LyX.h"
#include "MetricsInfo.h"
+#include "output_xhtml.h"
#include "sgml.h"
+#include "frontends/FontMetrics.h"
+
#include "support/docstream.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using std::string;
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNomencl
+//
+/////////////////////////////////////////////////////////////////////
-InsetNomencl::InsetNomencl(InsetCommandParams const & p)
- : InsetCommand(p, "nomenclature"),
+InsetNomencl::InsetNomencl(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "nomenclature"),
nomenclature_entry_id(sgml::uniqueID(from_ascii("nomen")))
{}
-CommandInfo const * InsetNomencl::findInfo(std::string const & /* cmdName */)
+ParamInfo const & InsetNomencl::findInfo(string const & /* cmdName */)
+{
+ static ParamInfo param_info_;
+ if (param_info_.empty()) {
+ param_info_.add("prefix", ParamInfo::LATEX_OPTIONAL);
+ param_info_.add("symbol", ParamInfo::LATEX_REQUIRED);
+ param_info_.add("description", ParamInfo::LATEX_REQUIRED);
+ }
+ return param_info_;
+}
+
+
+docstring InsetNomencl::screenLabel() const
{
- static const char * const paramnames[] = {"prefix", "symbol", "description", ""};
- static const bool isoptional[] = {true, false, false};
- static const CommandInfo info = {3, paramnames, isoptional};
- return &info;
+ size_t const maxLabelChars = 25;
+
+ docstring label = _("Nom: ") + getParam("symbol");
+ if (label.size() > maxLabelChars) {
+ label.erase(maxLabelChars - 3);
+ label += "...";
+ }
+ return label;
}
-docstring const InsetNomencl::getScreenLabel(Buffer const &) const
+docstring InsetNomencl::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
{
- return _("Nom");
+ docstring tip = _("Nomenclature Symbol: ") + getParam("symbol") + "\n";
+ tip += _("Description: ") + "\t"
+ + subst(getParam("description"), from_ascii("\\\\"), from_ascii("\n\t"));
+ if (!getParam("prefix").empty())
+ tip += "\n" + _("Sorting: ") + getParam("prefix");
+ return tip;
}
-int InsetNomencl::docbook(Buffer const &, odocstream & os,
- OutputParams const &) const
+
+int InsetNomencl::docbook(odocstream & os, OutputParams const &) const
{
os << "<glossterm linkend=\"" << nomenclature_entry_id << "\">"
<< sgml::escapeString(getParam("symbol"))
}
+docstring InsetNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+{
+ return docstring();
+}
+
+
int InsetNomencl::docbookGlossary(odocstream & os) const
{
os << "<glossentry id=\"" << nomenclature_entry_id << "\">\n"
}
-InsetPrintNomencl::InsetPrintNomencl(InsetCommandParams const & p)
- : InsetCommand(p, string())
+/////////////////////////////////////////////////////////////////////
+//
+// InsetPrintNomencl
+//
+/////////////////////////////////////////////////////////////////////
+
+InsetPrintNomencl::InsetPrintNomencl(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "nomencl_print")
{}
-CommandInfo const * InsetPrintNomencl::findInfo(std::string const & /* cmdName */)
+ParamInfo const & InsetPrintNomencl::findInfo(string const & /* cmdName */)
{
- static const char * const paramnames[] = {"labelwidth", ""};
- static const bool isoptional[] = {true};
- static const CommandInfo info = {1, paramnames, isoptional};
- return &info;
+ // The symbol width is set via nomencl's \nomlabelwidth in
+ // InsetPrintNomencl::latex and not as optional parameter of
+ // \printnomenclature
+ static ParamInfo param_info_;
+ if (param_info_.empty()) {
+ // how is the width set?
+ // values: none|auto|custom
+ param_info_.add("set_width", ParamInfo::LYX_INTERNAL);
+ // custom width
+ param_info_.add("width", ParamInfo::LYX_INTERNAL);
+ }
+ return param_info_;
}
-docstring const InsetPrintNomencl::getScreenLabel(Buffer const &) const
+docstring InsetPrintNomencl::screenLabel() const
{
return _("Nomenclature");
}
-int InsetPrintNomencl::docbook(Buffer const & buf, odocstream & os,
- OutputParams const &) const
+void InsetPrintNomencl::doDispatch(Cursor & cur, FuncRequest & cmd)
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY: {
+ InsetCommandParams p(NOMENCL_PRINT_CODE);
+ // FIXME UNICODE
+ InsetCommand::string2params("nomencl_print",
+ to_utf8(cmd.argument()), p);
+ if (p.getCmdName().empty()) {
+ cur.noUpdate();
+ break;
+ }
+ setParams(p);
+ break;
+ }
+
+ default:
+ InsetCommand::doDispatch(cur, cmd);
+ break;
+ }
+}
+
+
+bool InsetPrintNomencl::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_DIALOG_UPDATE:
+ case LFUN_INSET_MODIFY:
+ status.setEnabled(true);
+ return true;
+
+ default:
+ return InsetCommand::getStatus(cur, cmd, status);
+ }
+}
+
+
+docstring InsetPrintNomencl::xhtml(XHTMLStream &, OutputParams const &) const
+{
+ return docstring();
+}
+
+
+int InsetPrintNomencl::docbook(odocstream & os, OutputParams const &) const
{
os << "<glossary>\n";
int newlines = 2;
- for (InsetIterator it = inset_iterator_begin(buf.inset()); it;) {
+ InsetIterator it = inset_iterator_begin(buffer().inset());
+ while (it) {
if (it->lyxCode() == NOMENCL_CODE) {
newlines += static_cast<InsetNomencl const &>(*it).docbookGlossary(os);
++it;
- } else if(it->lyxCode() == NOTE_CODE &&
- static_cast<InsetNote const &>(*it).params().type == InsetNoteParams::Note) {
- // Don't output anything nested in note insets
+ } else if (!it->producesOutput()) {
+ // Ignore contents of insets that are not in output
size_t const depth = it.depth();
++it;
while (it.depth() > depth)
}
+namespace {
+docstring nomenclWidest(Buffer const & buffer)
+{
+ // nomenclWidest() determines and returns the widest used
+ // nomenclature symbol in the document
+
+ int w = 0;
+ docstring symb;
+ InsetNomencl const * nomencl = 0;
+ ParagraphList::const_iterator it = buffer.paragraphs().begin();
+ ParagraphList::const_iterator end = buffer.paragraphs().end();
+
+ for (; it != end; ++it) {
+ if (it->insetList().empty())
+ continue;
+ InsetList::const_iterator iit = it->insetList().begin();
+ InsetList::const_iterator eend = it->insetList().end();
+ for (; iit != eend; ++iit) {
+ Inset * inset = iit->inset;
+ if (inset->lyxCode() != NOMENCL_CODE)
+ continue;
+ nomencl = static_cast<InsetNomencl const *>(inset);
+ docstring const symbol =
+ nomencl->getParam("symbol");
+ // This is only an approximation,
+ // but the best we can get.
+ int const wx = use_gui ?
+ theFontMetrics(Font()).width(symbol) :
+ symbol.size();
+ if (wx > w) {
+ w = wx;
+ symb = symbol;
+ }
+ }
+ }
+ // return the widest (or an empty) string
+ return symb;
+}
+}
+
+
+int InsetPrintNomencl::latex(odocstream & os, OutputParams const &) const
+{
+ int lines = 0;
+ if (getParam("set_width") == "auto") {
+ docstring widest = nomenclWidest(buffer());
+ // Set the label width via nomencl's command \nomlabelwidth.
+ // This must be output before the command \printnomenclature
+ if (!widest.empty()) {
+ os << "\\settowidth{\\nomlabelwidth}{"
+ << widest
+ << "}\n";
+ ++lines;
+ }
+ } else if (getParam("set_width") == "custom") {
+ // custom length as optional arg of \printnomenclature
+ string const width =
+ Length(to_ascii(getParam("width"))).asLatexString();
+ os << '\\'
+ << from_ascii(getCmdName())
+ << '['
+ << from_ascii(width)
+ << "]{}";
+ return lines;
+ }
+ // output the command \printnomenclature
+ os << getCommand();
+ return lines;
+}
+
+
void InsetPrintNomencl::validate(LaTeXFeatures & features) const
{
features.require("nomencl");
}
+docstring InsetPrintNomencl::contextMenu(BufferView const &, int, int) const
+{
+ return from_ascii("context-nomenclprint");
+}
+
+
} // namespace lyx