X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBullet.h;h=662fa224d7d74e69f762fcf53f88bffebb252476;hb=90ea50811191dc891d2b3407c01527f1f2d745dd;hp=cc955085709179977e34d24cbf7ff3599450ca4c;hpb=e266fd847f7c1ec14c9802c85f19f1193bfdbf7c;p=features.git diff --git a/src/Bullet.h b/src/Bullet.h index cc95508570..662fa224d7 100644 --- a/src/Bullet.h +++ b/src/Bullet.h @@ -1,25 +1,24 @@ // -*- 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 "FontEnums.h" + +#include "support/docstring.h" -#include "LString.h" + +namespace lyx { /// class Bullet { @@ -28,7 +27,7 @@ public: Bullet(int f = -1, int c = -1, int s = -1); /// - explicit Bullet(string const &); + explicit Bullet(docstring const &); /// void setCharacter(int); @@ -37,7 +36,7 @@ public: /// void setSize(int); /// - void setText(string const &); + void setText(docstring const &); /// int getCharacter() const; /// @@ -45,22 +44,26 @@ public: /// int getSize() const; /// - string const & getText() const; + FontSize getFontSize() const; + /// The text to be output + docstring const & getText() const; + /// The label displayed in the workarea + docstring const & getLabel() 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) */ @@ -74,38 +77,41 @@ private: /// SIZEMAX = 10 }; - + /// void generateText() const; /// - static string const bulletSize(int); + static docstring const bulletSize(int); + /// + static FontSize bulletFontSize(int); /// - static string const bulletEntry(int, int); - + static docstring const bulletLabel(int, 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; + mutable docstring label; }; @@ -119,4 +125,7 @@ bool operator!=(Bullet const & b1, Bullet const & b2) extern Bullet const ITEMIZE_DEFAULTS[]; + +} // namespace lyx + #endif /* BULLET_H_ */