src/graphics/GraphicsSupport.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file GraphicsSupport.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 #ifndef GRAPHICSSUPPORT_H
  13 #define GRAPHICSSUPPORT_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "support/types.h"
  20 #include <list>
  21
  22 class BufferView;
  23 class Inset;
  24 class Paragraph;
  25
  26 /** A Paragraph * together with delimiters for the start and end positions
  27     of visibility.
  28  */
  29 struct VisibleParagraph {
  30         ///
  31         VisibleParagraph() : par(0), start(0), end(0) {}
  32         ///
  33         VisibleParagraph(Paragraph * p, lyx::pos_type s, lyx::pos_type e)
  34                 : par(p), start(s), end(e) {}
  35         ///
  36         Paragraph * par;
  37         ///
  38         lyx::pos_type start;
  39         ///
  40         lyx::pos_type end;
  41 };
  42
  43
  44 /// Returns a list of all Paragraphs currently visible in bv.
  45 std::list<VisibleParagraph> const getVisibleParagraphs(BufferView const & bv);
  46
  47 /** Given this data, check whether inset lies within it and is, therefore,
  48  *  visible.
  49  */
  50 bool isInsetVisible(Inset const & inset, std::list<VisibleParagraph> const &);
  51
  52 #endif // GRAPHICSSUPPORT_H