* \author Lars Gullik Bjornes
* \author John Levon
* \author Abdelrazak Younes
- * \author Peter Kümmel
+ * \author Peter Kümmel
*
* Full author contact details are available in file CREDITS.
*/
#ifndef GUI_VIEW_H
#define GUI_VIEW_H
+#include "frontends/Delegates.h"
#include "frontends/LyXView.h"
#include "support/strfwd.h"
namespace lyx {
-class ToolbarInfo;
+class Cursor;
namespace frontend {
class Dialog;
-class GuiLayoutBox;
+class LayoutBox;
class GuiToolbar;
class GuiWorkArea;
+class TabWorkArea;
+class TocModels;
+class ToolbarInfo;
/**
* GuiView - Qt4 implementation of LyXView
~GuiView();
- ///
- int id() const { return id_; }
- void close();
- void setFocus();
+ /// LyXView inherited methods.
+ ///@{
+ int id() const { return id_; };
void setBusy(bool);
- /// returns true if this view has the focus.
- bool hasFocus() const;
+ BufferView * currentBufferView();
+ BufferView const * currentBufferView() const;
+ BufferView * documentBufferView();
+ BufferView const * documentBufferView() const;
+ void newDocument(std::string const & filename,
+ bool fromTemplate);
+
+ /// could be called from any thread
+ void message(docstring const &);
+ /// must be called from GUI thread
+ void updateMessage(QString const & str);
+
+ bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
+ bool dispatch(FuncRequest const & cmd);
+ void restartCursor();
+ void updateCompletion(Cursor & cur, bool start, bool keep);
+ void setFocus();
+ ///@}
+
+ /// set a buffer to the current workarea.
+ void setBuffer(Buffer * b); ///< \c Buffer to set.
+
+ /// load a document into the current workarea.
+ Buffer * loadDocument(
+ support::FileName const & name, ///< File to load.
+ bool tolastfiles = true ///< append to the "Open recent" menu?
+ );
/// add toolbar, if newline==true, add a toolbar break before the toolbar
GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
- virtual void updateStatusBar();
- virtual void message(docstring const & str);
+ void updateStatusBar();
/// updates the possible layouts selectable
void updateLayoutList();
void updateToolbars();
QMenu * createPopupMenu();
- FuncStatus getStatus(FuncRequest const & cmd);
- void dispatch(FuncRequest const & cmd);
///
- void setLayoutDialog(GuiLayoutBox *);
-
- /// \return the buffer currently shown in this window
- Buffer * buffer();
- Buffer const * buffer() const;
- /// set a buffer to the current workarea.
- void setBuffer(Buffer * b); ///< \c Buffer to set.
+ LayoutBox * getLayoutDialog() const;
+
+ /// hides the workarea and makes sure it is clean
+ bool hideWorkArea(GuiWorkArea * wa);
+ /// closes the workarea
+ bool closeWorkArea(GuiWorkArea * wa);
+ /// closes the buffer
+ bool closeBuffer(Buffer & buf);
+ ///
+ void openDocument(std::string const & filename);
+ ///
+ void importDocument(std::string const &);
/// GuiBufferDelegate.
///@{
void resetAutosaveTimers();
- void errors(std::string const &);
- void structureChanged() { updateToc(); }
+ void errors(std::string const &, bool from_master = false);
+ void structureChanged();
+ void updateTocItem(std::string const &, DocIterator const &);
///@}
+
+ ///
+ TocModels & tocModels();
/// called on timeout
void autoSave();
- ///
- void updateEmbeddedFiles();
- /// \return the current buffer view.
- BufferView * view();
+ /// check for external change of any opened buffer, mainly for svn usage
+ void checkExternallyModifiedBuffers();
/** 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 *);
- ///
- void restartCursor();
/// \return the \c Workarea associated to \p Buffer
/// \retval 0 if no \c WorkArea is found.
/// \return the \c Workarea associated to \p Buffer
/// \retval 0 if no \c WorkArea is found.
GuiWorkArea * addWorkArea(Buffer & buffer);
- ///
+ /// \param work_area The current \c WorkArea, or \c NULL
void setCurrentWorkArea(GuiWorkArea * work_area);
///
void removeWorkArea(GuiWorkArea * work_area);
/// return the current WorkArea (the one that has the focus).
GuiWorkArea const * currentWorkArea() const;
+ /// return the current WorkArea (the one that has the focus).
+ GuiWorkArea * currentWorkArea();
+
+ /// return the current document WorkArea (it may not have the focus).
+ GuiWorkArea const * currentMainWorkArea() const;
+ /// return the current document WorkArea (it may not have the focus).
+ GuiWorkArea * currentMainWorkArea();
Q_SIGNALS:
void closing(int);
+ void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
public Q_SLOTS:
/// idle timeout.
private Q_SLOTS:
///
void updateWindowTitle(GuiWorkArea * wa);
+ ///
+ void resetWindowTitleAndIconText();
///
void on_currentWorkAreaChanged(GuiWorkArea *);
+ ///
+ void on_lastWorkAreaRemoved();
/// slots to change the icon size
void smallSizedIcons();
void normalSizedIcons();
void bigSizedIcons();
+ /// For completion of autosave or exporrt threads.
+ void threadFinished();
+
+ /// must be called in GUI thread
+ void doShowDialog(QString const & qname, QString const & qdata,
+ Inset * inset);
+
private:
+ /// Open given child document in current buffer directory.
+ void openChildDocument(std::string const & filename);
+ /// Close current document buffer.
+ bool closeBuffer();
+ /// Close all document buffers.
+ bool closeBufferAll();
///
- void addTabWorkArea();
+ TabWorkArea * addTabWorkArea();
/// connect to signals in the given BufferView
void connectBufferView(BufferView & bv);
/// disconnect from signals in the given buffer
void disconnectBuffer();
///
- void updateToc();
- ///
void dragEnterEvent(QDragEnterEvent * ev);
///
void dropEvent(QDropEvent * ev);
bool event(QEvent * e);
bool focusNextPrevChild(bool);
+ ///
+ bool goToFileRow(std::string const & argument);
+
///
struct GuiViewPrivate;
GuiViewPrivate & d;
///
void resetDialogs();
- /** Check the status of all visible dialogs and disable or reenable
+ /// Hide all visible dialogs
+ void hideAll() const;
+
+ /// Update all visible dialogs.
+ /**
+ * Check the status of all visible dialogs and disable or reenable
* them as appropriate.
*
* Disabling is needed for example when a dialog is open and the
* cursor moves to a position where the corresponding inset is not
* allowed.
*/
- void checkStatus();
+ void updateDialogs();
- /// Hide all visible dialogs
- void hideAll() const;
- /// Hide any dialogs that require a buffer for them to operate
- void hideBufferDependent() const;
- /** Update visible, buffer-dependent dialogs
- If the bool is true then a buffer change has occurred
- else it is still the same buffer.
- */
- void updateBufferDependent(bool) const;
-
- /** \param name == "bibtex", "citation" etc; an identifier used to
+ /** Show dialog could be called from arbitrary threads.
+ \param name == "bibtex", "citation" etc; an identifier used to
launch a particular dialog.
\param data is a string representation of the Inset contents.
It is often little more than the output from Inset::write.
std::string const & data, Inset * inset = 0);
/** \param name == "citation", "bibtex" etc; an identifier used
- to update the contents of a particular dialog with \param data.
+ to reset the contents of a particular dialog with \param data.
See the comments to 'show', above.
*/
void updateDialog(std::string const & name, std::string const & data);
private:
///
- Inset * getOpenInset(std::string const & name) const;
+ void saveLayout() const;
+ ///
+ bool restoreLayout();
+ ///
+ GuiToolbar * toolbar(std::string const & name);
+ ///
+ void constructToolbars();
+ ///
+ void initToolbars();
+ ///
+ void lfunUiToggle(FuncRequest const & cmd);
+ ///
+ void toggleFullScreen();
+ ///
+ void insertLyXFile(docstring const & fname);
+ ///
+ void insertPlaintextFile(docstring const & fname,
+ bool asParagraph);
+
+ /// Save a buffer as a new file.
+ /**
+ Write a buffer to a new file name and rename the buffer
+ according to the new file name.
+
+ This function is e.g. used by menu callbacks and
+ LFUN_BUFFER_WRITE_AS.
+
+ If 'newname' is empty, the user is asked via a
+ dialog for the buffer's new name and location.
+
+ If 'newname' is non-empty and has an absolute path, that is used.
+ Otherwise the base directory of the buffer is used as the base
+ for any relative path in 'newname'.
+ */
+ bool renameBuffer(Buffer & b, docstring const & newname);
+ ///
+ bool saveBuffer(Buffer & b);
+ /// closes a workarea, if close_buffer is true the buffer will
+ /// also be released, otherwise the buffer will be hidden.
+ bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
+ /// closes the tabworkarea and all tabs. If we are in a close event,
+ /// all buffers will be closed, otherwise they will be hidden.
+ bool closeTabWorkArea(TabWorkArea * twa);
+ /// gives the user the possibility to save his work
+ /// or to discard the changes. If hiding is true, the
+ /// document will be reloaded.
+ bool saveBufferIfNeeded(Buffer & buf, bool hiding);
+ /// closes all workareas
+ bool closeWorkAreaAll();
+ /// write all open workareas into the session file
+ void writeSession() const;
+ /// is the buffer in this workarea also shown in another tab ?
+ /// This tab can either be in the same view or in another one.
+ bool inMultiTabs(GuiWorkArea * wa);
+ /// is the buffer in this workarea also shown in another view ?
+ bool inMultiViews(GuiWorkArea * wa);
+ ///
+ enum NextOrPrevious {
+ NEXTBUFFER,
+ PREVBUFFER
+ };
+ ///
+ void gotoNextOrPreviousBuffer(NextOrPrevious np);
/// Is the dialog currently visible?
bool isDialogVisible(std::string const & name) const;
///
- Dialog * find_or_build(std::string const & name);
+ Dialog * findOrBuild(std::string const & name, bool hide_it);
///
Dialog * build(std::string const & name);
+ ///
+ void reloadBuffer();
+ ///
+ void dispatchVC(FuncRequest const & cmd);
+ ///
+ void showMessage();
/// This view ID.
int id_;
+
+ /// flag to avoid two concurrent close events.
+ bool closing_;
};
} // namespace frontend