small cleanup, doxygen, formatting changes

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

diff --git a/src/mathed/math_root.h b/src/mathed/math_root.h
index 2fdb3faad0463fcb9b69e275fb44c32d5b8561ad..bddb171dcf8f6cfecb38a3855d22de8d9a664658 100644 (file)
--- a/src/mathed/math_root.h
+++ b/src/mathed/math_root.h
@@ -6,7 +6,7 @@
  *  Created:     January 1999
  *  Description: Root math object
  *
- *  Copyright: (c) 1999 Alejandro Aguilar Sierra
+ *  Copyright: 1999 Alejandro Aguilar Sierra
  *
  *   You are free to use and modify this code under the terms of
  *   the GNU General Public Licence version 2 or later.
@@ -19,56 +19,70 @@
 #pragma interface
 #endif
 
-#include "math_defs.h"
-#include "math_inset.h"
+#include "math_sqrtinset.h"
 #include "symbol_def.h"
-#include "LString.h"
 
 
-///
-class MathRootInset: public MathSqrtInset {
- public:
-    ///
-    MathRootInset(short st = LM_ST_TEXT);
-    ///
-    //    MathRootInset(MathSqrtInset &);
-    ///
-    ~MathRootInset();
-    ///
-    MathedInset * Clone();
-    ///
-    void draw(Painter &, int x, int baseline);
-    ///
-    void Write(ostream &);
-    ///
-    void Write(string & file);
-    ///
-    void Metrics();
-    ///
-    bool Inside(int, int);
-    ///
-    void SetFocus(int, int);
-    ///
-    void SetData(LyxArrayBase *);
-    ///
-    void GetXY(int& x, int& y) const;
-    ///
-    LyxArrayBase * GetData();
-    ///
-    bool setArgumentIdx(int i);
-    ///
-    int  getArgumentIdx() { return idx; }
-    ///
-    int  getMaxArgumentIdx() { return 1; }
-    ///
-    void  SetStyle(short);
-
- protected:
-    ///
-    int idx;
-    ///
-    MathParInset * uroot;
-    ///
-    int wroot, dh;
+/** The general n-th root inset.
+    \author Alejandro Aguilar Sierra
+    \version January 1999
+ */
+class MathRootInset : public MathSqrtInset {
+public:
+       ///
+       explicit
+       MathRootInset(short st = LM_ST_TEXT);
+       ///
+       ~MathRootInset();
+       ///
+       MathedInset * Clone();
+       ///
+       void draw(Painter &, int x, int baseline);
+       ///
+       void Write(std::ostream &, bool fragile);
+       ///
+       void Metrics();
+       ///
+       bool Inside(int, int);
+       ///
+       void SetFocus(int, int);
+       ///
+       void setData(MathedArray *);
+       ///
+       void GetXY(int & x, int & y) const;
+       ///
+       MathedArray * GetData();
+       ///
+       bool setArgumentIdx(int i);
+       ///
+       int getArgumentIdx() const;
+       ///
+       int getMaxArgumentIdx() const;
+       ///
+       void SetStyle(short);
+private:
+       ///
+       int idx_;
+       ///
+       MathParInset * uroot_;
+       ///
+       int wroot_;
+       ///
+       int dh_;
 };
+
+
+inline
+int MathRootInset::getArgumentIdx() const
+{
+       return idx_;
+}
+
+
+inline
+int MathRootInset::getMaxArgumentIdx() const
+{
+       return 1;
+}
+
 #endif