// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995-2001 the LyX Team.
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
#ifndef INSET_H
#define INSET_H
-#ifdef __GNUG__
-#pragma interface
-#endif
#include <vector>
#include "LString.h"
-#include <X11/Xlib.h>
-#include "commandtags.h"
#include "LColor.h"
+#include "insetbase.h"
+#include "frontends/mouse_state.h"
+#include "support/types.h"
class LyXFont;
class BufferView;
class LyXLex;
class Paragraph;
class LyXCursor;
+class FuncRequest;
+class WordLangTuple;
struct LaTeXFeatures;
+namespace grfx {
+ class PreviewLoader;
+}
/// Insets
-class Inset {
+class Inset : public InsetBase {
public:
/** This is not quite the correct place for this enum. I think
the correct would be to let each subclass of Inset declare
///
LABEL_CODE, // 10
///
- IGNORE_CODE,
+ NOTE_CODE,
///
ACCENT_CODE,
///
///
FLOAT_CODE,
///
+ WRAP_CODE,
+ ///
MINIPAGE_CODE,
///
SPECIALCHAR_CODE, // 25
///
FLOAT_LIST_CODE,
///
- INDEX_PRINT_CODE
+ INDEX_PRINT_CODE,
+ ///
+ OPTARG_CODE
};
///
HIGHLY_EDITABLE
};
+ ///
+ typedef InsetBase::dispatch_result RESULT;
+
///
Inset();
///
/// what appears in the minibuffer when opening
virtual string const editMessage() const;
///
- virtual void edit(BufferView *, int x, int y, unsigned int button);
+ virtual void edit(BufferView *, int x, int y, mouse_button::state button);
///
virtual void edit(BufferView *, bool front = true);
///
virtual EDITABLE editable() const;
- /// This is called when the user clicks inside an inset
- virtual void insetButtonPress(BufferView *, int, int, int) {}
- /// This is called when the user releases the button inside an inset
- // the bool return is used to see if we opened a dialog so that we can
- // check this from an outer inset and open the dialog of the
- // outer inset if that one has one!
- virtual bool insetButtonRelease(BufferView *, int, int, int)
- { return editable() == IS_EDITABLE; }
- /// This is called when the user moves the mouse inside an inset
- virtual void insetMotionNotify(BufferView *, int , int , int) {}
+ ///
+ virtual RESULT localDispatch(FuncRequest const & cmd);
///
virtual bool isTextInset() const { return false; }
///
virtual bool doClearArea() const { return true; }
- ///
+ /// return true if the inset should be removed automatically
virtual bool autoDelete() const;
/// returns true the inset can hold an inset of given type
virtual bool insetAllowed(Inset::Code) const { return false; }
///
virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
///
- virtual int docbook(Buffer const *, std::ostream &) const = 0;
+ virtual int docbook(Buffer const *, std::ostream &, bool) const = 0;
/// Updates needed features for this inset.
virtual void validate(LaTeXFeatures & features) const;
- ///
- virtual bool deletable() const;
/// returns LyX code associated with the inset. Used for TOC, ...)
virtual Inset::Code lyxCode() const { return NO_CODE; }
return scx;
return 0;
}
- /// try to get a paragraph pointer from it's id if we have a
- /// paragraph to give back!
- virtual Paragraph * getParFromID(int /* id */) const {
- return 0;
- }
+
/// try to get a inset pointer from it's id if we have
/// an inset to give back!
virtual Inset * getInsetFromID(int /* id */) const {
///
// needed for spellchecking text
///
- virtual bool allowSpellcheck() { return false; }
+ virtual bool allowSpellcheck() const { return false; }
// should this inset be handled like a normal charater
virtual bool isChar() const { return false; }
// if this inset has paragraphs should they be output all as default
// paragraphs with "Standard" layout?
virtual bool forceDefaultParagraphs(Inset const *) const;
+ /** returns true if, when outputing LaTeX, font changes should
+ be closed before generating this inset. This is needed for
+ insets that may contain several paragraphs */
+ virtual bool noFontChange() const { return false; }
//
virtual void getDrawFont(LyXFont &) const {}
/* needed for widths which are % of something
minipage somewhere, it will be the width of this minipage */
virtual int latexTextWidth(BufferView *) const;
+ /// mark the inset contents as erased (for change tracking)
+ virtual void markErased() {}
+
+ /** Adds a LaTeX snippet to the Preview Loader for transformation
+ * into a bitmap image. Does not start the laoding process.
+ *
+ * Most insets have no interest in this capability, so the method
+ * defaults to empty.
+ */
+ virtual void addPreview(grfx::PreviewLoader &) const {}
+
+ /** Find the PreviewLoader, add a LaTeX snippet to it and
+ * start the loading process.
+ *
+ * Most insets have no interest in this capability, so the method
+ * defaults to empty.
+ */
+ virtual void generatePreview() const {}
+
+
protected:
///
mutable int top_x;
*/
class UpdatableInset : public Inset {
public:
- /** Dispatch result codes
- Now that nested updatable insets are allowed, the local dispatch
- becomes a bit complex, just two possible results (boolean)
- are not enough.
-
- DISPATCHED = the inset catched the action
- DISPATCHED_NOUPDATE = the inset catched the action and no update
- is needed here to redraw the inset
- FINISHED = the inset must be unlocked as a result
- of the action
- FINISHED_RIGHT = FINISHED, but put the cursor to the RIGHT of
- the inset.
- FINISHED_UP = FINISHED, but put the cursor UP of
- the inset.
- FINISHED_DOWN = FINISHED, but put the cursor DOWN of
- the inset.
- UNDISPATCHED = the action was not catched, it should be
- dispatched by lower level insets
- */
- enum RESULT {
- UNDISPATCHED = 0,
- DISPATCHED,
- DISPATCHED_NOUPDATE,
- FINISHED,
- FINISHED_RIGHT,
- FINISHED_UP,
- FINISHED_DOWN
- };
-
- /// To convert old binary dispatch results
- RESULT DISPATCH_RESULT(bool b) {
- return b ? DISPATCHED : FINISHED;
- }
-
///
UpdatableInset();
///
///
virtual void getCursorPos(BufferView *, int &, int &) const {}
///
- virtual void insetButtonPress(BufferView *, int x, int y, int button);
- ///
- // the bool return is used to see if we opened a dialog so that we can
- // check this from an outer inset and open the dialog of the outer inset
- // if that one has one!
- ///
- virtual bool insetButtonRelease(BufferView *,
- int x, int y, int button);
- ///
- virtual void insetKeyPress(XKeyEvent * ev);
- ///
- virtual void insetMotionNotify(BufferView *, int x, int y, int state);
- ///
virtual void insetUnlock(BufferView *);
///
- virtual void edit(BufferView *, int x, int y, unsigned int button);
+ virtual void edit(BufferView *, int x, int y, mouse_button::state button);
///
virtual void edit(BufferView *, bool front = true);
///
bool /*lr*/ = false)
{ return false; }
/// An updatable inset could handle lyx editing commands
- virtual RESULT localDispatch(BufferView *, kb_action, string const &);
+ virtual RESULT localDispatch(FuncRequest const & cmd);
///
bool isCursorVisible() const { return cursor_visible_; }
///
///
// needed for spellchecking text
///
- virtual bool allowSpellcheck() { return false; }
+ virtual bool allowSpellcheck() const { return false; }
///
- virtual string const selectNextWordToSpellcheck(BufferView *, float & value) const;
+ virtual WordLangTuple const
+ selectNextWordToSpellcheck(BufferView *, float & value) const;
///
- virtual void selectSelectedWord(BufferView *) { return; }
+ virtual void selectSelectedWord(BufferView *) {}
///
virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
return;
}
+
+ /// find the next change in the inset
+ virtual bool nextChange(BufferView * bv, lyx::pos_type & length);
+
///
// needed for search/replace functionality
///
virtual bool searchBackward(BufferView *, string const &,
bool = true, bool = false);
+
protected:
///
void toggleCursorVisible() const {
projects / lyx.git / blobdiff