src/insets/updatableinset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file updatableinset.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 UPDATABLEINSET_H
  16 #define UPDATABLEINSET_H
  17
  18 //  Updatable Insets. These insets can receive directly user interaction.
  19 //  Note that all pure methods from Inset class are pure here too.
  20 //  [Alejandro 080596]
  21
  22 #include "inset.h"
  23
  24 class UpdatableInset : public InsetOld {
  25 public:
  26         ///
  27         virtual EDITABLE editable() const;
  28         /// identification as text inset in a cursor slice
  29         UpdatableInset * asUpdatableInset() { return this; }
  30
  31         /// return the cursor pos, relative to the inset pos
  32         virtual void getCursorPos(int, int &, int &) const {}
  33         /// return the cursor dim
  34         virtual void getCursorDim(int &, int &) const;
  35         // We need this method to not clobber the real method in Inset
  36         int scroll(bool recursive = true) const
  37                 { return InsetOld::scroll(recursive); }
  38         ///
  39         virtual bool showInsetDialog(BufferView *) const { return false; }
  40
  41 protected:
  42         ///  An updatable inset could handle lyx editing commands
  43         virtual
  44         DispatchResult
  45         priv_dispatch(LCursor & cur, FuncRequest const & cmd);
  46         /// scrolls to absolute position in bufferview-workwidth * sx units
  47         void scroll(BufferView &, float sx) const;
  48         /// scrolls offset pixels
  49         void scroll(BufferView &, int offset) const;
  50 };
  51
  52 #endif