]> git.lyx.org Git - lyx.git/blob - src/mathed/math_unknowninset.h
Standardise the header blurb in mathed.
[lyx.git] / src / mathed / math_unknowninset.h
1 // -*- C++ -*-
2 /**
3  * \file math_unknowninset.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author André Pönitz
8  *
9  * Full author contact details are available in file CREDITS.
10  */
11
12 #ifndef MATH_UNKNOWNINSET_H
13 #define MATH_UNKNOWNINSET_H
14
15 #include "math_diminset.h"
16
17 /// Unknowntions or LaTeX names for objects that we really don't know
18 class MathUnknownInset : public MathDimInset {
19 public:
20         ///
21         explicit MathUnknownInset(string const & name,
22                 bool final = true, bool black = false);
23         ///
24         virtual std::auto_ptr<InsetBase> clone() const;
25         ///
26         void metrics(MetricsInfo & mi, Dimension & dim) const;
27         ///
28         void draw(PainterInfo & pi, int x, int y) const;
29         ///
30         void setName(string const & name);
31         ///
32         string name() const;
33         /// identifies UnknownInsets
34         MathUnknownInset const * asUnknownInset() const { return this; }
35         /// identifies UnknownInsets
36         MathUnknownInset * asUnknownInset() { return this; }
37         ///
38         bool match(MathAtom const & at) const;
39
40         ///
41         void normalize(NormalStream &) const;
42         ///
43         void maple(MapleStream &) const;
44         ///
45         void mathematica(MathematicaStream &) const;
46         ///
47         void mathmlize(MathMLStream &) const;
48         ///
49         void octave(OctaveStream &) const;
50         ///
51         void finalize();
52         ///
53         bool final() const;
54 private:
55         ///
56         string name_;
57         /// are we finished creating the name?
58         bool final_;
59         ///
60         bool black_;
61 };
62 #endif