src/frontends/LyXView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXView.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LYXVIEW_H
  14 #define LYXVIEW_H
  15
  16 #include "frontends/Application.h"
  17 #include "frontends/Toolbars.h"
  18
  19 #include "lyxfunc.h"
  20 #include <boost/scoped_ptr.hpp>
  21 #include <boost/shared_ptr.hpp>
  22 #include <boost/signal.hpp>
  23 #include <boost/signals/trackable.hpp>
  24 #include <boost/utility.hpp>
  25
  26 namespace lyx {
  27
  28 class Buffer;
  29 class InsetBase;
  30 class Menubar;
  31
  32 class BufferView;
  33 class Dialogs;
  34 class LyXFunc;
  35 class LyXFont;
  36 class Timeout;
  37 class FuncRequest;
  38
  39 namespace frontend {
  40 class WorkArea;
  41 class ControlCommandBuffer;
  42 } // namespace frontend
  43
  44
  45 /**
  46  * LyXView - main LyX window
  47  *
  48  * This class represents the main LyX window and provides
  49  * accessor functions to its content.
  50  *
  51  * The eventual intention is that LyX will support a number
  52  * of containing LyXViews. Currently a lot of code still
  53  * relies on there being a single top-level view.
  54  *
  55  * Additionally we would like to support multiple views
  56  * in a single LyXView.
  57  */
  58 class LyXView : public boost::signals::trackable, boost::noncopyable {
  59 public:
  60
  61         LyXView();
  62
  63         virtual ~LyXView();
  64
  65         void setWorkArea(frontend::WorkArea * work_area);
  66
  67         /**
  68          * This is called after the concrete view has been created.
  69          * We have to have the toolbar and the other stuff created
  70          * before we can populate it with this call.
  71          */
  72         virtual void init() = 0;
  73
  74         virtual void setGeometry(
  75                 unsigned int width,
  76                 unsigned int height,
  77                 int posx, int posy,
  78                 bool maximize) = 0;
  79
  80         /// show busy cursor
  81         virtual void busy(bool) const = 0;
  82
  83         virtual Toolbars::ToolbarPtr makeToolbar(ToolbarBackend::Toolbar const & tbb) = 0;
  84
  85         //@{ generic accessor functions
  86
  87         /** return the current buffer view
  88             Returned as a shared_ptr so that anything wanting to cache the
  89             buffer view can do so safely using a boost::weak_ptr.
  90          */
  91         BufferView * view() const;
  92
  93         /// return the buffer currently shown in this window
  94         Buffer * buffer() const;
  95
  96         /// return the toolbar for this view
  97         Toolbars & getToolbars() { return *toolbars_.get(); }
  98         ///
  99         Toolbars const & getToolbars() const { return *toolbars_.get(); }
 100
 101         /// return the menubar for this view
 102         Menubar & getMenubar() { return *menubar_.get(); }
 103         ///
 104         Menubar const & getMenubar() const { return *menubar_.get(); }
 105
 106         /// get access to the dialogs
 107         Dialogs & getDialogs() { return *dialogs_.get(); }
 108         ///
 109         Dialogs const & getDialogs() const { return *dialogs_.get(); }
 110
 111         //@}
 112
 113         /// load a buffer into the current workarea
 114         bool loadLyXFile(std::string const &  name, bool tolastfiles = true);
 115
 116         /// set a buffer to the current workarea
 117         void setBuffer(Buffer * b);
 118
 119         /// updates the possible layouts selectable
 120         void updateLayoutChoice();
 121
 122         /// update the toolbar
 123         void updateToolbars();
 124         /// update the menubar
 125         void updateMenubar();
 126         /// update the status bar
 127         virtual void updateStatusBar() = 0;
 128
 129         /// focus the command buffer (minibuffer)
 130         boost::signal<void()> focus_command_buffer;
 131
 132         /// display a message in the view
 133         virtual void message(docstring const &) = 0;
 134
 135         /// clear any temporary message and replace with current status
 136         virtual void clearMessage() = 0;
 137
 138         /// updates the title of the window
 139         void updateWindowTitle();
 140
 141         /// reset autosave timer
 142         void resetAutosaveTimer();
 143
 144         /// dispatch to current BufferView
 145         void dispatch(FuncRequest const & cmd);
 146
 147         /** redraw \c inset in all the BufferViews in which it is currently
 148          *  visible. If successful return a pointer to the owning Buffer.
 149          */
 150         Buffer const * const updateInset(InsetBase const *) const;
 151
 152         /// returns true if this view has the focus.
 153         virtual bool hasFocus() const = 0;
 154
 155         /// show the error list to the user
 156         void showErrorList(std::string const &);
 157
 158         /// connect to signals in the given BufferView
 159         void connectBufferView(BufferView & bv);
 160         /// disconnect from signals in the given BufferView
 161         void disconnectBufferView();
 162
 163 protected:
 164         /// current work area (screen view of a BufferView).
 165         /**
 166         \todo FIXME: there is only one workArea per LyXView for now.
 167         */
 168         frontend::WorkArea * work_area_;
 169
 170         /// view's menubar
 171         boost::scoped_ptr<Menubar> menubar_;
 172
 173 private:
 174         /**
 175          * setWindowTitle - set title of window
 176          * @param t main window title
 177          * @param it iconified (short) title
 178          */
 179         virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;
 180
 181         /// called on timeout
 182         void autoSave();
 183
 184         /// view's toolbar
 185         boost::scoped_ptr<Toolbars> toolbars_;
 186         /// auto-saving of buffers
 187         boost::scoped_ptr<Timeout> const autosave_timeout_;
 188         /// our function handler
 189         boost::scoped_ptr<LyXFunc> lyxfunc_;
 190         /// dialogs for this view
 191         boost::scoped_ptr<Dialogs> dialogs_;
 192
 193         /// buffer changed signal connection
 194         boost::signals::connection bufferChangedConnection_;
 195         /// buffer errors signal connection
 196         boost::signals::connection errorsConnection_;
 197         /// buffer messages signal connection
 198         boost::signals::connection messageConnection_;
 199         /// buffer busy status signal connection
 200         boost::signals::connection busyConnection_;
 201         /// buffer title changed signal connection
 202         boost::signals::connection titleConnection_;
 203         /// buffer reset timers signal connection
 204         boost::signals::connection timerConnection_;
 205         /// buffer readonly status changed signal connection
 206         boost::signals::connection readonlyConnection_;
 207         /// buffer closing signal connection
 208         boost::signals::connection closingConnection_;
 209         /// connect to signals in the given buffer
 210         void connectBuffer(Buffer & buf);
 211         /// disconnect from signals in the given buffer
 212         void disconnectBuffer();
 213
 214         /// BufferView messages signal connection
 215         //@{
 216         boost::signals::connection message_connection_;
 217         boost::signals::connection show_dialog_connection_;
 218         boost::signals::connection show_dialog_with_data_connection_;
 219         boost::signals::connection show_inset_dialog_connection_;
 220         boost::signals::connection update_dialog_connection_;
 221         boost::signals::connection layout_changed_connection_;
 222         //@}
 223
 224         /// Bind methods for BufferView messages signal connection
 225         //@{
 226         void showDialog(std::string const & name);
 227         void showDialogWithData(std::string const & name,
 228                 std::string const & data);
 229         void showInsetDialog(std::string const & name,
 230                 std::string const & data, InsetBase * inset);
 231         void updateDialog(std::string const & name,
 232                 std::string const & data);
 233         //@}
 234
 235         /// notify readonly status
 236         void showReadonly(bool);
 237
 238 protected:
 239         /// view's command buffer controller
 240         // this has to be declared _after_ lyxfunc_ as its initialization depends
 241         // on it!
 242         typedef boost::scoped_ptr<frontend::ControlCommandBuffer>
 243         CommandBufferPtr;
 244
 245         CommandBufferPtr const controlcommand_;
 246 };
 247
 248 } // namespace lyx
 249
 250 #endif // LYXVIEW_H