lyx_mirror/src/insets/InsetCaption.h
Guillaume Munch d5a5fbb8ee Enhancements and bugfixes to the TOCs
* New TOC "math-macro". This means that math macros can now be accessed in the
  outline pane in their order of appearance or in alphabetical order, and can be
  searched using the filter.

* Lists of floats now show subfloats deeper in the navigation menu

* The arbitrary 30 element cut-off after which nothing is shown except "Open
  Navigator..." is removed. Menus now have no limit in size, so Qt may display
  them scrollable. In exchange, we always show "Open outliner..." at the
  beginning. I tested for performance issues with a rather complex document and
  it is fine; but this does not exclude corner cases with lots of TOC entries of
  a certain kind. If necessary, populating the navigation sub-menu should be
  delayed like the main menu.

* Elements that do not contribute to the output (e.g. in a note, a disabled
  branch) are now preceded with a symbol indicating this status. (The machinery
  was already there; I wonder why it was not implemented already.) I have chosen
  U+274E NEGATIVE SQUARED CROSS MARK.

* Fix the contextual menus in the outliner (bug introduced at 94e992c5).

* Toc item now move to the caption when present, but first center on the float,
  to prevent the situation where the caption is at the top of the screen and the
  contents of the float is off-screen above the caption.
  (Internally, the action of the toc items can now be customised)

* Fix the LyXHTML output. Disabled captions no longer appear in the list of
  figures.
2015-10-01 21:44:22 +01:00

109 lines
2.9 KiB
C++

// -*- C++ -*-
/**
* \file InsetCaption.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETCAPTION_H
#define INSETCAPTION_H
#include "InsetText.h"
namespace lyx {
/** A caption inset
*/
class InsetCaption : public InsetText {
public:
///
InsetCaption(Buffer *, std::string const &);
///
std::string const & floattype() const { return floattype_; }
///
docstring layoutName() const;
/// return the mandatory argument (LaTeX format) only
void getArgument(otexstream & os, OutputParams const &) const;
/// return the caption text
int getCaptionAsPlaintext(odocstream & os, OutputParams const &) const;
/// return the caption text as HTML
docstring getCaptionAsHTML(XHTMLStream & os, OutputParams const &) const;
///
std::string contextMenuName() const;
private:
///
void write(std::ostream & os) const;
///
DisplayType display() const { return AlignCenter; }
///
bool neverIndent() const { return true; }
///
bool forceLocalFontSwitch() const { return true; }
///
InsetCode lyxCode() const { return CAPTION_CODE; }
///
void cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const;
///
bool descendable(BufferView const &) const { return true; }
///
void metrics(MetricsInfo & mi, Dimension & dim) const;
///
void drawBackground(PainterInfo & pi, int x, int y) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void edit(Cursor & cur, bool front, EntryDirection entry_from);
///
Inset * editXY(Cursor & cur, int x, int y);
///
bool insetAllowed(InsetCode code) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
// Update the counters of this inset and of its contents
void updateBuffer(ParIterator const &, UpdateType);
///
void latex(otexstream & os, OutputParams const &) const;
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream & os, OutputParams const & runparams) const;
///
docstring xhtml(XHTMLStream & os, OutputParams const & runparams) const;
///
void setCustomLabel(docstring const & label);
///
void addToToc(DocIterator const & di, bool output_active, UpdateType utype) const;
///
virtual bool forcePlainLayout(idx_type = 0) const { return true; }
/// Captions don't accept alignment, spacing, etc.
virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
///
Inset * clone() const { return new InsetCaption(*this); }
///
mutable docstring full_label_;
///
mutable int labelwidth_;
///
std::string floattype_;
///
bool is_subfloat_;
///
std::string type_;
///
docstring custom_label_;
};
} // namespace lyx
#endif