// -*- C++ -*-
-/* This is the bullet class definition file.
- * This file is part of
- * ======================================================
+/**
+ * \file Bullet.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author Lars Gullik Bjønnes
+ * \author Allan Rae
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * This file Copyright 1997-1999
- * Allan Rae
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef BULLET_H
#define BULLET_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/docstring.h"
+
-#include "LString.h"
+namespace lyx {
///
class Bullet {
Bullet(int f = -1, int c = -1, int s = -1);
///
- explicit Bullet(string const &);
+ explicit Bullet(docstring const &);
///
void setCharacter(int);
///
void setSize(int);
///
- void setText(string const &);
+ void setText(docstring const &);
///
int getCharacter() const;
///
///
int getSize() const;
///
- string const & getText() const;
+ docstring const & getText() const;
///
Bullet & operator=(Bullet const &);
///
friend bool operator==(Bullet const &, Bullet const &);
+ ///
+ static docstring const bulletEntry(int, int);
protected:
-#ifdef ENABLE_ASSERTIONS
///
void testInvariant() const;
-#endif
private:
/**
This enum makes adding additional panels or changing panel sizes
easier. Since you only need change these values for all tests to
be correct for the new values.
-
+
Note: MAX means the size of the array so to test you need:
(x < MAX) *not* (x <= MAX)
*/
///
SIZEMAX = 10
};
-
+
///
void generateText() const;
///
- static string const bulletSize(int);
- ///
- static string const bulletEntry(int, int);
-
+ static docstring const bulletSize(int);
+
///
int font;
///
int character;
///
int size;
-
- // size, character and font are array indices to access
+
+ // size, character and font are array indices to access
// the predefined arrays of LaTeX equivalent strings.
-
+
/** flag indicates if user has control of text (1)
or if I can use it to generate strings (0)
or have already (-1)
*/
- mutable short user_text;
-
+ mutable short user_text;
+
//NOTE: Arranging these four shorts above to be together
// like this should ensure they are in a single cache line
-
+
/** text may contain a user-defined LaTeX symbol command
or one generated internally from the font, character
and size settings.
*/
- mutable string text;
+ mutable docstring text;
};
extern
Bullet const ITEMIZE_DEFAULTS[];
+
+} // namespace lyx
+
#endif /* BULLET_H_ */