// -*- C++ -*-
/**
* \file LyXView.h
- * Copyright 1995-2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjornes <larsbj@lyx.org>
- * \author John Levon <moz@compsoc.man.ac.uk>
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef LYXVIEW_H
#define LYXVIEW_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "frontends/Application.h"
+#include "frontends/Delegates.h"
+#include "support/docstring.h"
-#include "LString.h"
+#include <boost/noncopyable.hpp>
-#include "support/types.h"
+#include <vector>
-#include <boost/utility.hpp>
-#include <boost/scoped_ptr.hpp>
-#include <boost/signals/trackable.hpp>
+namespace lyx {
-class Buffer;
-class Toolbar;
-class MiniBuffer;
-class Intl;
-class Menubar;
+namespace support { class FileName; }
+class Font;
+class Buffer;
class BufferView;
-class Dialogs;
-class LyXFunc;
-class LyXFont;
+class FuncRequest;
+class Inset;
class Timeout;
+class ToolbarInfo;
+
+namespace frontend {
+
+class Dialogs;
+class WorkArea;
/**
* LyXView - main LyX window
* Additionally we would like to support multiple views
* in a single LyXView.
*/
-class LyXView : public boost::signals::trackable, boost::noncopyable {
+class LyXView : boost::noncopyable,
+ public GuiBufferViewDelegate, public GuiBufferDelegate
+{
public:
-
- LyXView();
-
+ ///
+ LyXView(int id);
+ ///
virtual ~LyXView();
+ ///
+ int id() const { return id_; }
+ ///
+ virtual void close() = 0;
+ ///
+ virtual void setFocus() = 0;
+
+ ///
+ virtual WorkArea * workArea(Buffer & buffer) = 0;
+ ///
+ virtual WorkArea * addWorkArea(Buffer & buffer) = 0;
+ ///
+ virtual void setCurrentWorkArea(WorkArea * work_area) = 0;
+ ///
+ virtual void removeWorkArea(WorkArea * work_area) = 0;
+ /// return the current WorkArea (the one that has the focus).
+ virtual WorkArea const * currentWorkArea() const = 0;
+ /// FIXME: This non-const access is needed because of
+ /// a mis-designed \c ControlSpellchecker.
+ virtual WorkArea * currentWorkArea() = 0;
- /// FIXME: what is the requirement for this be to separate from the ctor ?
- void init();
-
- /// start modal operation
- virtual void prohibitInput() const = 0;
- /// end modal operation
- virtual void allowInput() const = 0;
+ /**
+ * This is called after the concrete view has been created.
+ * We have to have the toolbar and the other stuff created
+ * before we can populate it with this call.
+ */
+ virtual void init() = 0;
+
+ enum Maximized {
+ NotMaximized,
+ VerticallyMaximized,
+ HorizontallyMaximized,
+ CompletelyMaximized
+ };
+
+ ///
+ virtual void setGeometry(
+ unsigned int width,
+ unsigned int height,
+ int posx, int posy,
+ int maximize,
+ unsigned int iconSizeXY,
+ const std::string & geometryArg) = 0;
+
+ /// save the geometry state in the session manager.
+ virtual void saveGeometry() = 0;
+
+ /// show busy cursor
+ virtual void setBusy(bool) = 0;
//@{ generic accessor functions
- /// return the current buffer view
- BufferView * view() const;
-
- /// return the LyX function handler for this view
- LyXFunc * getLyXFunc() const;
-
- /// return the buffer currently shown in this window
- Buffer * buffer() const;
-
- /// return the toolbar for this view
- Toolbar * getToolbar() const;
+ /// \return the current buffer view.
+ BufferView * view();
- /// return the menubar for this view
- Menubar * getMenubar() const;
+ /// \return the buffer currently shown in this window
+ Buffer * buffer();
+ Buffer const * buffer() const;
- /// return the minibuffer for this view
- /// FIXME: I'm not at all sure that LyXFunc should be
- /// aware of a mini buffer as such
- MiniBuffer * getMiniBuffer() const;
+ ///
+ virtual void openLayoutList() = 0;
+ ///
+ virtual bool isToolbarVisible(std::string const & id) = 0;
+ ///
+ virtual void showMiniBuffer(bool visible) = 0;
+ virtual void openMenu(docstring const & name) = 0;
/// get access to the dialogs
- Dialogs * getDialogs() { return dialogs_.get(); }
-
- /// get this view's keyboard map handler
- Intl * getIntl() const;
+ Dialogs & getDialogs() { return *dialogs_; }
+ ///
+ Dialogs const & getDialogs() const { return *dialogs_; }
//@}
- /// sets the layout in the toolbar layout selection
- void setLayout(string const & layout);
+ /// load a buffer into the current workarea.
+ Buffer * loadLyXFile(support::FileName const & name, ///< File to load.
+ bool tolastfiles = true); ///< append to the "Open recent" menu?
+
+ /// set a buffer to the current workarea.
+ void setBuffer(Buffer * b); ///< \c Buffer to set.
+
/// updates the possible layouts selectable
- void updateLayoutChoice();
+ virtual void updateLayoutChoice() = 0;
/// update the toolbar
- void updateToolbar();
- /// update the menubar
- void updateMenubar();
+ virtual void updateToolbars() = 0;
+ /// get toolbar info
+ virtual ToolbarInfo * getToolbarInfo(std::string const & name) = 0;
+ /// toggle toolbar state
+ virtual void toggleToolbarState(std::string const & name, bool allowauto) = 0;
+ /// update the status bar
+ virtual void updateStatusBar() = 0;
/// display a message in the view
- void message(string const &);
- /// push a message onto the history, and show it
- void messagePush(string const & str);
- /// pop the last message pushed
- void messagePop();
- /// show state (font etc.) in minibuffer
- void showState();
-
+ virtual void message(docstring const &) = 0;
+
+ /// clear any temporary message and replace with current status
+ virtual void clearMessage() = 0;
+
/// updates the title of the window
void updateWindowTitle();
/// reset autosave timer
void resetAutosaveTimer();
-protected:
- /// view of a buffer. Eventually there will be several.
- boost::scoped_ptr<BufferView> bufferview_;
-
- /// view's menubar
- boost::scoped_ptr<Menubar> menubar_;
- /// view's toolbar
- boost::scoped_ptr<Toolbar> toolbar_;
- /// view's minibuffer
- boost::scoped_ptr<MiniBuffer> minibuffer_;
+ /// dispatch to current BufferView
+ void dispatch(FuncRequest const & cmd);
- /// keyboard mapping object
- boost::scoped_ptr<Intl> intl_;
+ /** redraw \c inset in all the BufferViews in which it is currently
+ * visible. If successful return a pointer to the owning Buffer.
+ */
+ Buffer const * updateInset(Inset const *);
- /// auto-saving of buffers
- boost::scoped_ptr<Timeout> autosave_timeout_;
+ /// returns true if this view has the focus.
+ virtual bool hasFocus() const = 0;
- /// called on timeout
- void autoSave();
+ /// show the error list to the user
+ void showErrorList(std::string const &);
- /// FIXME: GUII - toolbar property
- void invalidateLayoutChoice();
+
+ //
+ // GuiBufferDelegate
+ //
+ /// This function is called when the buffer structure is changed.
+ void structureChanged() { updateToc(); }
+ /// This function is called when some parsing error shows up.
+ void errors(std::string const & err) { showErrorList(err); }
+ /// This function is called when the buffer readonly status change.
+ void setReadOnly(bool on);
+ /// Update window titles of all users.
+ void updateTitles() { updateWindowTitle(); }
+ /// Reset autosave timers for all users.
+ void resetAutosaveTimers() { resetAutosaveTimer(); }
+
+ /// connect to signals in the given BufferView
+ void connectBufferView(BufferView & bv);
+ /// disconnect from signals in the given BufferView
+ void disconnectBufferView();
+ /// connect to signals in the given buffer
+ void connectBuffer(Buffer & buf);
+ /// disconnect from signals in the given buffer
+ void disconnectBuffer();
private:
/**
* @param t main window title
* @param it iconified (short) title
*/
- virtual void setWindowTitle(string const & t, string const & it) = 0;
+ virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;
- /// our function handler
- boost::scoped_ptr<LyXFunc> lyxfunc_;
+ /// called on timeout
+ void autoSave();
+
+ /// auto-saving of buffers
+ Timeout * const autosave_timeout_;
/// dialogs for this view
- boost::scoped_ptr<Dialogs> dialogs_;
+ Dialogs * dialogs_;
+
+ /// Bind methods for BufferView messages signal connection
+ //@{
+ void showDialog(std::string const & name);
+ void showDialogWithData(std::string const & name,
+ std::string const & data);
+ void showInsetDialog(std::string const & name,
+ std::string const & data, Inset * inset);
+ void updateDialog(std::string const & name,
+ std::string const & data);
+ //@}
- /**
- * The last textclass layout list in the layout choice selector
- * This should probably be moved to the toolbar, but for now it's
- * here. (Asger)
- *
- * FIXME: GUII
- */
- int last_textclass_;
+protected:
+ ///
+ void updateToc();
+ ///
+ void updateEmbeddedFiles();
+
+private:
+ int id_;
};
+} // namespace frontend
+} // namespace lyx
+
#endif // LYXVIEW_H
projects / lyx.git / blobdiff