]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_scriptinset.h
Jean-Marc's fix for wrong descent
[lyx.git] / src / mathed / math_scriptinset.h
index 45920dbc73590baf2b861dabd5600e5b99c6086e..fa5dc7653fc92d2a3d7ea3132cc63375e99559c0 100644 (file)
@@ -4,74 +4,78 @@
 
 #include "math_nestinset.h"
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 /** Inset for super- and subscripts
-    \author André Pönitz
+ *  \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS
  */
 
 class MathScriptInset : public MathNestInset {
 public:
-       ///
+       /// create inset without scripts
        MathScriptInset();
-       ///
+       /// create inset with single script
        explicit MathScriptInset(bool up);
+       /// create inset with single script and given nucleus
+       MathScriptInset(MathAtom const & at, bool up);
        ///
        MathInset * clone() const;
        ///
-       void write(WriteStream & os) const;
+       void metrics(MathMetricsInfo & mi) const;
        ///
-       void normalize(NormalStream & os) const;
+       void draw(MathPainterInfo & pi, int x, int y) const;
        ///
-       void metrics(MathMetricsInfo const & st) const;
+       void metricsT(TextMetricsInfo const & mi) const;
        ///
-       void draw(Painter &, int x, int y) const;
+       void drawT(TextPainter & pi, int x, int y) const;
 
-       ///
-       void metrics(MathInset const * nuc, MathMetricsInfo const & st) const;
-       ///
-       void draw(MathInset const * nuc, Painter &, int x, int y) const;
-       ///
-       int ascent(MathInset const * nuc) const;
-       ///
-       int descent(MathInset const * nuc) const;
-       ///
-       int width(MathInset const * nuc) const;
-
-       ///
+       /// write LaTeX and Lyx code
+       void write(WriteStream & os) const;
+       /// write normalized content
+       void normalize(NormalStream &) const;
+       /// write content as something readable by Maple
+       void maple(MapleStream &) const;
+       /// write content as something readable by Mathematica
+       void mathematica(MathematicaStream &) const;
+       /// write content as something resembling MathML
+       void mathmlize(MathMLStream &) const;
+       /// write content as something readable by Octave
+       void octave(OctaveStream &) const;
+       /// move cursor left
        bool idxLeft(idx_type &, pos_type &) const;
-       ///
+       /// move cursor right
        bool idxRight(idx_type &, pos_type &) const;
-       ///
-       bool idxFirstUp(idx_type &, pos_type &) const;
-       ///
-       bool idxFirstDown(idx_type &, pos_type &) const;
-       ///
-       bool idxLastUp(idx_type &, pos_type &) const;
-       ///
-       bool idxLastDown(idx_type &, pos_type &) const;
+       /// move cursor up or down
+       bool idxUpDown(idx_type & idx, pos_type & pos, bool up, int targetx) const;
+       /// Target pos when we enter the inset from the left by pressing "Right"
+       bool idxFirst(idx_type & idx, pos_type & pos) const;
+       /// Target pos when we enter the inset from the right by pressing "Left"
+       bool idxLast(idx_type & idx, pos_type & pos) const;
+       /// can we enter this cell?
+       bool validCell(idx_type i) const { return i == 2 || script_[i]; }
 
-       ///
+       /// identifies scriptinsets
        MathScriptInset const * asScriptInset() const;
        ///
        MathScriptInset * asScriptInset();
 
        /// set limits
        void limits(int lim) { limits_ = lim; }
-       /// 
+       /// get limits
        int limits() const { return limits_; }
-       ///
-       bool hasLimits(MathInset const * nuc) const;
-       /// true if we have an "inner" position
-       MathXArray const & up() const;
        /// returns subscript
-       MathXArray const & down() const;
-       /// returns superscript
-       MathXArray & up();
+       MathArray const & down() const;
        /// returns subscript
-       MathXArray & down();
+       MathArray & down();
+       /// returns superscript
+       MathArray const & up() const;
+       /// returns superscript
+       MathArray & up();
+       /// returns nucleus
+       MathArray const & nuc() const;
+       /// returns nucleus
+       MathArray & nuc();
        /// do we have a superscript?
        bool hasUp() const;
        /// do we have a subscript?
@@ -80,49 +84,41 @@ public:
        bool has(bool up) const;
        /// remove script
        void removeScript(bool up);
-       /// remove script
-       void removeEmptyScripts();
-       ///
+       /// make sure a script is accessible
        void ensure(bool up);
+       /// say that we have scripts
+       void infoize(std::ostream & os) const;
+       /// say whether we have displayed limits
+       void infoize2(std::ostream & os) const;
+       /// local dispatcher
+       dispatch_result dispatch(FuncRequest const & cmd, idx_type & idx, pos_type & pos);
 
-       // call these methods ...2 to make compaq cxx in anal mode happy...
-       /// suppresses empty braces if necessary
-       virtual void write2(MathInset const * nuc, WriteStream & os) const;
-       /// 
-       virtual void normalize2(MathInset const * nuc, NormalStream & os) const;
-       ///
-       virtual void octavize2(MathInset const * nuc, OctaveStream & os) const;
-       ///
-       virtual void maplize2(MathInset const * nuc, MapleStream & os) const;
-       ///
-       virtual void mathmlize2(MathInset const * nuc, MathMLStream & os) const;
-
-public:
+private:
        /// returns x offset for main part
-       int dxx(MathInset const * nuc) const;
+       int dxx() const;
        /// returns width of nucleus if any
-       int nwid(MathInset const * nuc) const;
-private:
+       int nwid() const;
        /// returns y offset for superscript
-       int dy0(MathInset const * nuc) const;
+       int dy0() const;
        /// returns y offset for subscript
-       int dy1(MathInset const * nuc) const;
+       int dy1() const;
        /// returns x offset for superscript
-       int dx0(MathInset const * nuc) const;
+       int dx0() const;
        /// returns x offset for subscript
-       int dx1(MathInset const * nuc) const;
+       int dx1() const;
        /// returns ascent of nucleus if any
-       int nasc(MathInset const * nuc) const;
+       int nasc() const;
        /// returns descent of nucleus if any
-       int ndes(MathInset const * nuc) const;
+       int ndes() const;
+       /// where do we have to draw the scripts?
+       bool hasLimits() const;
+       /// clean up empty cells
+       void notifyCursorLeaves(idx_type idx);
 
        /// possible subscript (index 0) and superscript (index 1)
-       bool script_[2]; 
-       ///
+       bool script_[2];
+       /// 1 - "limits", -1 - "nolimits", 0 - "default"
        int limits_;
-       ///
-       mutable MathMetricsInfo mi_;
 };
 
 #endif
-