src/insets/inset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file inset.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author Jürgen Vigna
   9  * \author Lars Gullik Bjønnes
  10  * \author Matthias Ettrich
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef INSETOLD_H
  16 #define INSETOLD_H
  17
  18 #include "insetbase.h"
  19 #include "dimension.h"
  20
  21 class LColor_color;
  22 class UpdatableInset;
  23
  24
  25 /// Insets
  26 class InsetOld : public InsetBase {
  27 public:
  28         ///
  29         enum {
  30                 ///
  31                 TEXT_TO_INSET_OFFSET = 2
  32         };
  33
  34         ///
  35         InsetOld();
  36         ///
  37         InsetOld(InsetOld const & in);
  38         ///
  39         int ascent() const;
  40         ///
  41         int descent() const;
  42         ///
  43         int width() const;
  44
  45         ///
  46         void setInsetName(std::string const & s) { name_ = s; }
  47         ///
  48         std::string const & getInsetName() const { return name_; }
  49         ///
  50         void setOwner(UpdatableInset * inset) { owner_ = inset; }
  51         ///
  52         UpdatableInset * owner() const { return owner_; }
  53         ///
  54         virtual void setBackgroundColor(LColor_color);
  55         ///
  56         LColor_color backgroundColor() const;
  57         ///
  58         int x() const { return xo_; }
  59         ///
  60         int y() const { return yo_; }
  61         /// returns the actual scroll-value
  62         virtual int scroll(bool recursive = true) const;
  63
  64         ///
  65         bool forceDefaultParagraphs(InsetBase const * inset) const;
  66 protected:
  67         ///
  68         mutable int xo_;
  69         ///
  70         mutable int yo_;
  71         ///
  72         mutable int scx;
  73         ///
  74         mutable Dimension dim_;
  75
  76 private:
  77         ///
  78         UpdatableInset * owner_;
  79         ///
  80         std::string name_;
  81         /** We store the LColor::color value as an int to get LColor.h out
  82          *  of the header file.
  83          */
  84         int background_color_;
  85 };
  86
  87
  88 /** \c InsetOld_code is a wrapper for InsetOld::Code.
  89  *  It can be forward-declared and passed as a function argument without
  90  *  having to expose inset.h.
  91  */
  92 class InsetOld_code {
  93         InsetOld::Code val_;
  94 public:
  95         InsetOld_code(InsetOld::Code val) : val_(val) {}
  96         operator InsetOld::Code() const { return val_; }
  97 };
  98
  99 #endif