src/insets/insetinfo.h

   1 // -*- C++ -*-
   2 /* This file is part of*
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-1999 the LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef INSET_INFO_H
  13 #define INSET_INFO_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "lyxinset.h"
  20 #include FORMS_H_LOCATION
  21 #include "LString.h"
  22
  23 /** Info. Handles the note insets.
  24
  25   This class handles the note insets. The edit operation bringes up
  26   a dialog, where the user can type a note about life or something
  27   else of interest. When collapsed, the inset is displayed as "Note"
  28   in a yellow box. Currently, the Read-function is a terrible hack.
  29   Some day in the distant future, this will hopefully be obsoleted by
  30   a true comment-environment. */
  31 class InsetInfo : public Inset {
  32 public:
  33         ///
  34         InsetInfo();
  35         ///
  36         InsetInfo(string const & string);
  37         ///
  38         ~InsetInfo();
  39         ///
  40         int ascent(Painter &, LyXFont const &) const;
  41         ///
  42         int descent(Painter &, LyXFont const &) const;
  43         ///
  44         int width(Painter &, LyXFont const &) const;
  45         ///
  46         void draw(Painter &, LyXFont const &, int baseline, float & x) const;
  47         ///
  48         void Write(ostream &) const;
  49         ///
  50         void Read(LyXLex & lex);
  51         ///
  52         int Latex(ostream &, signed char fragile, bool free_spc) const;
  53 #ifndef USE_OSTREAM_ONLY
  54         ///
  55         int Latex(string & file, signed char fragile, bool free_spc) const;
  56         ///
  57         int Linuxdoc(string & file) const;
  58         ///
  59         int DocBook(string & file) const;
  60 #else
  61         ///
  62         int Linuxdoc(ostream &) const;
  63         ///
  64         int DocBook(ostream &) const;
  65 #endif
  66         /// what appears in the minibuffer when opening
  67         const char * EditMessage() const {return _("Opened note");}
  68         ///
  69         void Edit(BufferView *, int, int, unsigned int);
  70         ///
  71         EDITABLE Editable() const;
  72         ///
  73         Inset::Code LyxCode() const;
  74         ///
  75         Inset * Clone() const;
  76         ///
  77         static void CloseInfoCB(FL_OBJECT *, long data);
  78 private:
  79         ///
  80         string contents;
  81         ///
  82         FL_FORM * form;
  83         ///
  84         FL_OBJECT * strobj;
  85 };
  86 #endif