make \newcommand{\bb}[1]{\mathbf{#1}} work for read/write/display.

[lyx.git] / src / mathed / math_atom.h

diff --git a/src/mathed/math_atom.h b/src/mathed/math_atom.h
index 938d1170ec939382a36f527f1cb1bc273bdd9950..8e78a4b0c8188047d3d1a070946aa27a4c0b65f4 100644 (file)
--- a/src/mathed/math_atom.h
+++ b/src/mathed/math_atom.h
@@ -22,6 +22,10 @@ Ok: Implementing it thusly is not feasible since cursor movement gets
 hackish. We use MathAtom only as a wrapper around MathInset * with value
 semantics.
 
+The MathAtom owns the MathInset * and is responsible for proper cloning and
+destruction. Every MathInset * should be put into a MathAtom after its
+creation as soon as possible.
+
 Andre'
 
 */
@@ -30,29 +34,27 @@ class MathInset;
 
 class MathAtom {
 public: 
-       ///
+       /// default constructor, object is useless, but we need it to put it into
+       // std::containers
        MathAtom();
-       ///
-       MathAtom(MathAtom const &);
-       ///
+       /// the "real constructor"
        explicit MathAtom(MathInset * p);
-       /// 
-       virtual ~MathAtom(); 
-       ///
+       /// copy constructor, invokes nucleus_->clone()
+       MathAtom(MathAtom const &);
+       /// we really need to clean up
+       ~MathAtom(); 
+       /// assignment invokes nucleus_->clone()
        void operator=(MathAtom const &);
-       ///
+       /// change inset under the hood
+       void reset(MathInset * p);
+       /// access to the inset
        MathInset * nucleus() const;
-       ///
+       /// access to the inset
        MathInset * operator->() const;
 
 private:
        ///
        MathInset * nucleus_;
-
-       /// raw copy
-       void copy(MathAtom const & p);
-       /// raw destruction
-       void done();
 };
 
 #endif