lyx_mirror/src/insets/InsetCitation.h
Guillaume Munch bb344452c8 Consistency of ellipses across the UI
Use the function support:truncateWithEllipsis() to shorten a docstring with
... at the end. Actually we use U+2026 HORIZONTAL ELLIPSIS instead of "..." when
automatically shortening strings. This is to be consistent with Qt's own
truncation and is much nicer on the screen.

This includes the bugs #9575 and #9572 regarding broken text elision in the
outliner.

Known issues (non-regressions):

* TocBackend::updateItem() should be rewritten to update all TOCs. (#8386)

* "..." should be replaced with … everywhere else on the interface (including
  translation strings).

* We should prefer to rely on QFontMetrics::elidedText() to truncate strings
  with an ellipsis whenever possible, or an equivalent for the buffer view
  dependent on the font metrics. See the warning in src/support/lstrings.h.
2015-10-05 21:16:16 +01:00

126 lines
2.9 KiB
C++

// -*- C++ -*-
/**
* \file InsetCitation.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_CITATION_H
#define INSET_CITATION_H
#include "InsetCommand.h"
namespace lyx {
/////////////////////////////////////////////////////////////////////////
//
// InsetCitation
//
/////////////////////////////////////////////////////////////////////////
/// Used to insert citations
class InsetCitation : public InsetCommand
{
public:
///
InsetCitation(Buffer * buf, InsetCommandParams const &);
///
~InsetCitation();
///
bool addKey(std::string const & key);
/// \name Public functions inherited from Inset class
//@{
///
bool isLabeled() const { return true; }
///
bool hasSettings() const { return true; }
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
InsetCode lyxCode() const { return CITE_CODE; }
///
void latex(otexstream &, OutputParams const &) const;
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void toString(odocstream &) const;
///
void forOutliner(docstring &, size_t const, bool const) const;
///
void validate(LaTeXFeatures &) const {}
///
void updateBuffer(ParIterator const & it, UpdateType);
///
void addToToc(DocIterator const & di, bool output_active,
UpdateType utype) const;
///
std::string contextMenuName() const;
//@}
/// \name Static public methods obligated for InsetCommand derived classes
//@{
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "cite"; }
///
static bool isCompatibleCommand(std::string const & cmd);
//@}
private:
/// tries to make a pretty label and makes a basic one if not
docstring generateLabel(bool for_xhtml = false) const;
/// makes a pretty label
docstring complexLabel(bool for_xhtml = false) const;
/// makes a very basic label, in case we can't make a pretty one
docstring basicLabel(bool for_xhtml = false) const;
/// \name Private functions inherited from Inset class
//@{
///
Inset * clone() const { return new InsetCitation(*this); }
//@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const;
//@}
/// we'll eventually want to be able to get info on this from the
/// various CiteEngines
static ParamInfo param_info_;
///
struct Cache {
Cache() : recalculate(true) {}
///
bool recalculate;
///
docstring generated_label;
///
docstring screen_label;
};
///
mutable Cache cache;
};
} // namespace lyx
#endif // INSET_CITATION_H