src/frontends/LyXView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXView.h
   4  * Copyright 1995-2002 the LyX Team
   5  * Read the file COPYING
   6  *
   7  * \author Lars Gullik Bjønnes <larsbj@lyx.org>
   8  * \author John Levon <moz@compsoc.man.ac.uk>
   9  */
  10
  11 #ifndef LYXVIEW_H
  12 #define LYXVIEW_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "LString.h"
  19
  20 #include "support/types.h"
  21
  22 #include <boost/utility.hpp>
  23 #include <boost/scoped_ptr.hpp>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/signals/trackable.hpp>
  26 #include <boost/signals/signal0.hpp>
  27
  28 class Buffer;
  29 class Toolbar;
  30 class Intl;
  31 class Menubar;
  32 class ControlCommandBuffer;
  33
  34 class BufferView;
  35 class Dialogs;
  36 class LyXFunc;
  37 class LyXFont;
  38 class Timeout;
  39
  40 /**
  41  * LyXView - main LyX window
  42  *
  43  * This class represents the main LyX window and provides
  44  * accessor functions to its content.
  45  *
  46  * The eventual intention is that LyX will support a number
  47  * of containing LyXViews. Currently a lot of code still
  48  * relies on there being a single top-level view.
  49  *
  50  * Additionally we would like to support multiple views
  51  * in a single LyXView.
  52  */
  53 class LyXView : public boost::signals::trackable, boost::noncopyable {
  54 public:
  55
  56         LyXView();
  57
  58         virtual ~LyXView();
  59
  60         /**
  61          * This is called after the concrete view has been created.
  62          * We have to have the toolbar and the other stuff created
  63          * before we can populate it with this call.
  64          */
  65         void init();
  66
  67         /// start modal operation
  68         virtual void prohibitInput() const = 0;
  69         /// end modal operation
  70         virtual void allowInput() const = 0;
  71
  72         //@{ generic accessor functions
  73
  74         /** return the current buffer view
  75             Returned as a shared_ptr so that anything wanting to cache the
  76             buffer view can do so safely using a boost::weak_ptr.
  77          */
  78         boost::shared_ptr<BufferView> const & view() const;
  79
  80         /// return the LyX function handler for this view
  81         LyXFunc * getLyXFunc() const;
  82
  83         /// return the buffer currently shown in this window
  84         Buffer * buffer() const;
  85
  86         /// return the toolbar for this view
  87         Toolbar * getToolbar() const;
  88
  89         /// return the menubar for this view
  90         Menubar * getMenubar() const;
  91
  92         /// get access to the dialogs
  93         Dialogs * getDialogs() { return dialogs_.get(); }
  94
  95         /// get this view's keyboard map handler
  96         Intl * getIntl() const;
  97
  98         //@}
  99
 100         /// sets the layout in the toolbar layout selection
 101         void setLayout(string const & layout);
 102         /// updates the possible layouts selectable
 103         void updateLayoutChoice();
 104
 105         /// update the toolbar
 106         void updateToolbar();
 107         /// update the menubar
 108         void updateMenubar();
 109
 110         /// focus the command buffer (minibuffer)
 111         boost::signal0<void> focus_command_buffer;
 112
 113         /// view state string changed
 114         boost::signal0<void> view_state_changed;
 115
 116         /// display a message in the view
 117         virtual void message(string const &) = 0;
 118
 119         /// updates the title of the window
 120         void updateWindowTitle();
 121
 122         /// reset autosave timer
 123         void resetAutosaveTimer();
 124
 125 protected:
 126         /// view of a buffer. Eventually there will be several.
 127         boost::shared_ptr<BufferView> bufferview_;
 128
 129         /// view's menubar
 130         boost::scoped_ptr<Menubar> menubar_;
 131         /// view's toolbar
 132         boost::scoped_ptr<Toolbar> toolbar_;
 133         /// view's command buffer controller
 134         boost::scoped_ptr<ControlCommandBuffer> controlcommand_;
 135
 136         /// keyboard mapping object
 137         boost::scoped_ptr<Intl> intl_;
 138
 139         /// auto-saving of buffers
 140         boost::scoped_ptr<Timeout> autosave_timeout_;
 141
 142         /// called on timeout
 143         void autoSave();
 144
 145 private:
 146         /**
 147          * setWindowTitle - set title of window
 148          * @param t main window title
 149          * @param it iconified (short) title
 150          */
 151         virtual void setWindowTitle(string const & t, string const & it) = 0;
 152
 153         /// our function handler
 154         boost::scoped_ptr<LyXFunc> lyxfunc_;
 155         /// dialogs for this view
 156         boost::scoped_ptr<Dialogs> dialogs_;
 157 };
 158
 159 #endif // LYXVIEW_H