// -*- C++ -*-
+/**
+ * \file LyXView.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
+ */
-#ifndef LYXVIEW_BASE_H
-#define LYXVIEW_BASE_H
+#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/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 FuncRequest;
+class Inset;
class Timeout;
+class ToolbarInfo;
-///
-class LyXView : public boost::signals::trackable, boost::noncopyable {
+namespace frontend {
+
+class Dialogs;
+class WorkArea;
+
+/**
+ * LyXView - main LyX window
+ *
+ * This class represents the main LyX window and provides
+ * accessor functions to its content.
+ *
+ * The eventual intention is that LyX will support a number
+ * of containing LyXViews. Currently a lot of code still
+ * relies on there being a single top-level view.
+ *
+ * Additionally we would like to support multiple views
+ * in a single LyXView.
+ */
+class LyXView : boost::noncopyable,
+ public GuiBufferViewDelegate, public GuiBufferDelegate
+{
public:
///
- LyXView();
+ LyXView(int id);
///
virtual ~LyXView();
///
- virtual void init() = 0;
+ int id() const { return id_; }
///
- virtual void setPosition(int, int) = 0;
+ virtual void close() = 0;
///
- virtual void show(int, int, string const &) = 0;
- /// Redraw the main form.
- virtual void redraw() = 0;
+ virtual void setFocus() = 0;
- /// Resize all BufferViews in this LyXView (because the width changed)
- void resize();
+ ///
+ 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;
- /// returns the buffer currently shown in the main form.
- Buffer * buffer() const;
+ /**
+ * 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
+ };
///
- BufferView * view() const;
+ virtual void setGeometry(
+ unsigned int width,
+ unsigned int height,
+ int posx, int posy,
+ int maximize,
+ unsigned int iconSizeXY,
+ const std::string & geometryArg) = 0;
- /// return a pointer to the toolbar
- Toolbar * getToolbar() const;
+ /// save the geometry state in the session manager.
+ virtual void saveGeometry() = 0;
- /// sets the layout in the toolbar layout combox
- void setLayout(string const & layout);
- /// update the toolbar
- void updateToolbar();
+ /// show busy cursor
+ virtual void setBusy(bool) = 0;
+
+ //@{ generic accessor functions
- /// return a pointer to the lyxfunc
- LyXFunc * getLyXFunc() const;
+ /// \return the current buffer view.
+ BufferView * view();
- /// return a pointer to the minibuffer
- MiniBuffer * getMiniBuffer() const;
+ /// \return the buffer currently shown in this window
+ Buffer * buffer();
+ Buffer const * buffer() const;
///
- void message(string const &);
+ virtual void openLayoutList() = 0;
///
- void messagePush(string const & str);
+ virtual bool isToolbarVisible(std::string const & id) = 0;
///
- void messagePop();
+ virtual void showMiniBuffer(bool visible) = 0;
+ virtual void openMenu(docstring const & name) = 0;
+ /// get access to the dialogs
+ Dialogs & getDialogs() { return *dialogs_; }
///
- Menubar * getMenubar() const;
+ Dialogs const & getDialogs() const { return *dialogs_; }
- ///
- void updateMenubar();
+ //@}
- ///
- Intl * getIntl() const;
+ /// 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?
- ///
- Dialogs * getDialogs() { return dialogs_; }
+ /// set a buffer to the current workarea.
+ void setBuffer(Buffer * b); ///< \c Buffer to set.
- ///
- void updateLayoutChoice();
+ /// updates the possible layouts selectable
+ virtual void updateLayoutChoice() = 0;
- /// Updates the title of the window
- void updateWindowTitle();
+ /// update the toolbar
+ 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
+ virtual void message(docstring const &) = 0;
- /// Show state (toolbar and font in minibuffer)
- void showState();
+ /// clear any temporary message and replace with current status
+ virtual void clearMessage() = 0;
- /// Reset autosave timer
+ /// updates the title of the window
+ void updateWindowTitle();
+
+ /// reset autosave timer
void resetAutosaveTimer();
- ///
- virtual void prohibitInput() const = 0;
- ///
- virtual void allowInput() const = 0;
+
+ /// dispatch to current BufferView
+ void dispatch(FuncRequest const & cmd);
+
+ /** 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 *);
+
+ /// returns true if this view has the focus.
+ virtual bool hasFocus() const = 0;
+
+ /// show the error list to the user
+ void showErrorList(std::string const &);
+
+
+ //
+ // 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:
+ /**
+ * setWindowTitle - set title of window
+ * @param t main window title
+ * @param it iconified (short) title
+ */
+ virtual void setWindowTitle(docstring const & t, docstring const & it) = 0;
+
+ /// called on timeout
+ void autoSave();
+
+ /// auto-saving of buffers
+ Timeout * const autosave_timeout_;
+ /// dialogs for this view
+ 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);
+ //@}
+
protected:
///
- Menubar * menubar;
- ///
- Toolbar * toolbar;
- /** This is supposed to be a pointer or a list of pointers to the
- BufferViews currently being shown in the LyXView. So far
- this is not used, but that should change pretty soon. (Lgb) */
- BufferView * bufferview;
+ void updateToc();
///
- MiniBuffer * minibuffer;
- ///
- Intl * intl;
- ///
- Timeout * autosave_timeout;
- /// A callback
- void AutoSave();
- ///
- void invalidateLayoutChoice();
+ void updateEmbeddedFiles();
+
private:
- ///
- LyXFunc * lyxfunc;
- ///
- Dialogs * dialogs_;
- ///
- virtual void setWindowTitle(string const &, string const &) = 0;
- /** 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) */
- int last_textclass;
+ int id_;
};
-#endif
+
+} // namespace frontend
+} // namespace lyx
+
+#endif // LYXVIEW_H
projects / lyx.git / blobdiff