// -*- C++ -*-
/* This file is part of
- * ======================================================
- *
+ * ======================================================
+ *
* LyX, The Document Processor
- *
+ *
* Copyright 1995-2001 the LyX Team.
*
* ====================================================== */
///
HIGHLY_EDITABLE
};
-
+
///
Inset();
///
/// 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
- virtual void insetButtonRelease(BufferView *, int, int, int) {}
+ // 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 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; }
-
+
virtual std::vector<string> const getLabelList() const {
return std::vector<string>();
}
///
virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
-
+
/// returns true to override begin and end inset in file
virtual bool directWrite() const;
virtual bool checkInsertChar(LyXFont &);
/// we need this here because collapsed insets are only EDITABLE
virtual void setFont(BufferView *, LyXFont const &,
- bool toggleall = false, bool selectall = false);
+ bool toggleall = false, bool selectall = false);
///
// needed for spellchecking text
///
virtual bool allowSpellcheck() { return false; }
+ // should this inset be handled like a normal charater
+ virtual bool isChar() const { return false; }
// is this equivalent to a letter?
virtual bool isLetter() const { return false; }
- // is this equivalent to a space?
+ // is this equivalent to a space (which is BTW different from
+ // a line separator)?
virtual bool isSpace() const { return false; }
+ // should we break lines after this inset?
+ virtual bool isLineSeparator() 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;
+ //
+ virtual void getDrawFont(LyXFont &) const {}
+ /* needed for widths which are % of something
+ returns the value of \textwidth in this inset. Most of the
+ time this is the width of the workarea, but if there is a
+ minipage somewhere, it will be the width of this minipage */
+ virtual int latexTextWidth(BufferView *) const;
protected:
///
inline
bool Inset::insetAllowed(Inset * in) const
-{
- return insetAllowed(in->lyxCode());
+{
+ return insetAllowed(in->lyxCode());
}
// Updatable Insets. These insets can be locked and receive
// directly user interaction. Currently used only for mathed.
// Note that all pure methods from Inset class are pure here too.
-// [Alejandro 080596]
+// [Alejandro 080596]
/** Extracted from Matthias notes:
- *
- * An inset can simple call LockInset in it's edit call and *ONLY*
+ *
+ * An inset can simple call LockInset in it's edit call and *ONLY*
* in it's edit call.
*
- * Unlocking is either done by LyX or the inset itself with a
+ * Unlocking is either done by LyX or the inset itself with a
* UnlockInset-call
*
* During the lock, all button and keyboard events will be modified
* and send to the inset through the following inset-features. Note that
* Inset::insetUnlock will be called from inside UnlockInset. It is meant
* to contain the code for restoring the menus and things like this.
- *
+ *
* If a inset wishes any redraw and/or update it just has to call
- * UpdateInset(this).
- *
+ * updateInset(this).
+ *
* It's is completly irrelevant, where the inset is. UpdateInset will
- * find it in any paragraph in any buffer.
+ * find it in any paragraph in any buffer.
* Of course the_locking_inset and the insets in the current paragraph/buffer
* are checked first, so no performance problem should occur.
*/
/** 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.
-
+ 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
+ is needed here to redraw the inset
FINISHED = the inset must be unlocked as a result
- of the action
+ of the action
FINISHED_RIGHT = FINISHED, but put the cursor to the RIGHT of
- the inset.
+ the inset.
FINISHED_UP = FINISHED, but put the cursor UP of
- the inset.
+ the inset.
FINISHED_DOWN = FINISHED, but put the cursor DOWN of
- the inset.
+ the inset.
UNDISPATCHED = the action was not catched, it should be
- dispatched by lower level insets
- */
+ dispatched by lower level insets
+ */
enum RESULT {
UNDISPATCHED = 0,
DISPATCHED,
FINISHED_UP,
FINISHED_DOWN
};
-
+
/// To convert old binary dispatch results
RESULT DISPATCH_RESULT(bool b) {
return b ? DISPATCHED : FINISHED;
virtual bool checkInsertChar(LyXFont &);
///
virtual EDITABLE editable() const;
-
- /// may call ToggleLockedInsetCursor
+
+ ///
virtual void toggleInsetCursor(BufferView *);
///
virtual void showInsetCursor(BufferView *, bool show = true);
///
virtual void insetButtonPress(BufferView *, int x, int y, int button);
///
- virtual void insetButtonRelease(BufferView *,
+ // 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);
{ return false; }
///
virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
- bool /*lr*/ = false)
+ bool /*lr*/ = false)
{ return false; }
/// An updatable inset could handle lyx editing commands
virtual RESULT localDispatch(BufferView *, kb_action, string const &);
// needed for search/replace functionality
///
virtual bool searchForward(BufferView *, string const &,
- bool const & = true, bool const & = false);
+ bool = true, bool = false);
///
virtual bool searchBackward(BufferView *, string const &,
- bool const & = true, bool const & = false);
+ bool = true, bool = false);
protected:
///
*/
inline bool isEditableInset(Inset * i)
{
- return i && i->editable();
+ return i && i->editable();
}
-
+
/**
* returns true if pointer argument is valid
* and points to a highly editable inset
projects / lyx.git / blobdiff