#define GUI_VIEW_H
#include "frontends/Delegates.h"
-#include "frontends/LyXView.h"
#include "support/strfwd.h"
namespace lyx {
+namespace support { class FileName; }
+
+class Buffer;
+class BufferView;
class Cursor;
+class DispatchResult;
+class FuncStatus;
+class FuncRequest;
+class Inset;
namespace frontend {
class ToolbarInfo;
/**
- * GuiView - Qt4 implementation of LyXView
+ * GuiView - Qt4 main LyX window
*
- * qt4-private implementation of the main LyX window.
+ * This class represents the main LyX window and provides
+ * accessor functions to its content.
*
* Note: a QObject emits a destroyed(QObject *) Qt signal when it
* is deleted. This might be useful for closing other dialogs
* depending on a given GuiView.
*/
-class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
+class GuiView : public QMainWindow, public GuiBufferViewDelegate,
public GuiBufferDelegate
{
Q_OBJECT
+
public:
/// create a main window of the given dimensions
GuiView(int id);
~GuiView();
- /// LyXView inherited methods.
- ///@{
- int id() const { return id_; };
- void setBusy(bool);
+ /// closes the view such that the view knows that is closed
+ /// programmatically and not by the user clicking the x.
+ bool closeScheduled();
+
+ int id() const { return id_; }
+
+ /// are we busy ?
+ bool busy() const;
+
+
+ /// \name Generic accessor functions
+ //@{
+ /// The current BufferView refers to the BufferView that has the focus,
+ /// including for example the one that is created when you use the
+ /// advanced search and replace pane.
+ /// \return the currently selected buffer view.
BufferView * currentBufferView();
BufferView const * currentBufferView() const;
+
+ /// The document BufferView always refers to the view's main document
+ /// BufferView. So, even if the BufferView in e.g., the advanced
+ /// search and replace pane has the focus.
+ /// \return the current document buffer view.
BufferView * documentBufferView();
BufferView const * documentBufferView() const;
+
void newDocument(std::string const & filename,
bool fromTemplate);
+ /// display a message in the view
/// 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);
+ /// dispatch command.
+ /// \return true if the \c FuncRequest has been dispatched.
+ void dispatch(FuncRequest const & cmd, DispatchResult & dr);
+
void restartCursor();
+ /// Update the completion popup and the inline completion state.
+ /// If \c start is true, then a new completion might be started.
+ /// If \c keep is true, an active completion will be kept active
+ /// even though the cursor moved. The update flags of \c cur might
+ /// be changed.
void updateCompletion(Cursor & cur, bool start, bool keep);
+
+ ///
void setFocus();
- ///@}
+ ///
+ void focusInEvent(QFocusEvent * e);
/// set a buffer to the current workarea.
void setBuffer(Buffer * b); ///< \c Buffer to set.
///
void importDocument(std::string const &);
- /// GuiBufferDelegate.
- ///@{
+ /// \name GuiBufferDelegate.
+ //@{
void resetAutosaveTimers();
void errors(std::string const &, bool from_master = false);
void structureChanged();
void updateTocItem(std::string const &, DocIterator const &);
- ///@}
+ //@}
///
TocModels & tocModels();
/// \return the \c Workarea associated to \p Buffer
/// \retval 0 if no \c WorkArea is found.
GuiWorkArea * workArea(Buffer & buffer);
+ /// \return the \c Workarea at index \c index
+ GuiWorkArea * workArea(int index);
/// Add a \c WorkArea
/// \return the \c Workarea associated to \p Buffer
void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
public Q_SLOTS:
+ ///
+ void setBusy(bool);
/// idle timeout.
/// clear any temporary message and replace with current status.
void clearMessage();
void normalSizedIcons();
void bigSizedIcons();
- /// For completion of autosave or exporrt threads.
- void threadFinished();
+ /// For completion of autosave or export threads.
+ void processingThreadStarted();
+ void processingThreadFinished();
+ void autoSaveThreadFinished();
/// must be called in GUI thread
void doShowDialog(QString const & qname, QString const & qdata,
Inset * inset);
+ /// must be called from GUI thread
+ void updateStatusBarMessage(QString const & str);
+ void clearMessageText();
+
private:
/// Open given child document in current buffer directory.
void openChildDocument(std::string const & filename);
///
void disconnectDialog(std::string const & name);
- /// Find or create buffer view and WorkArea for supplied document
- /// buffer and make it current.
- void selectDocumentBuffer(Buffer const * p_buf);
-
private:
- ///
+ /// Saves the layout and geometry of the window
void saveLayout() const;
+ /// Saves the settings of toolbars and all dialogs
+ void saveUISettings() const;
///
bool restoreLayout();
///
///
void initToolbars();
///
- void lfunUiToggle(FuncRequest const & cmd);
+ bool lfunUiToggle(std::string const & ui_component);
///
void toggleFullScreen();
///
///
void insertPlaintextFile(docstring const & fname,
bool asParagraph);
+ ///
+ bool exportBufferAs(Buffer & b);
/// Save a buffer as a new file.
/**
bool renameBuffer(Buffer & b, docstring const & newname);
///
bool saveBuffer(Buffer & b);
+ /// save and rename buffer to fn. If fn is empty, the buffer
+ /// is just saved as the filename it already has.
+ bool saveBuffer(Buffer & b, support::FileName const & fn);
/// 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);
/// 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);
+ /// is the buffer shown in some other view ?
+ bool inOtherView(Buffer & buf);
///
enum NextOrPrevious {
NEXTBUFFER,
///
Dialog * build(std::string const & name);
///
- void reloadBuffer();
- void reloadBuffer(Buffer * buf);
+ bool reloadBuffer(Buffer & buffer);
+ ///
+ void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
///
- void dispatchVC(FuncRequest const & cmd);
+ void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
///
void showMessage();
/// flag to avoid two concurrent close events.
bool closing_;
+ /// if the view is busy the cursor shouldn't blink for instance.
+ /// This counts the number of times more often we called
+ /// setBusy(true) compared to setBusy(false), so we can nest
+ /// functions that call setBusy;
+ int busy_;
+
};
} // namespace frontend
projects / lyx.git / blobdiff