#define GUI_VIEW_H
#include "frontends/Delegates.h"
-#include "frontends/LyXView.h"
#include "support/strfwd.h"
#include <QMainWindow>
+#include <QMenu>
class QCloseEvent;
class QDragEnterEvent;
class QDropEvent;
-class QMenu;
+class QLabel;
class QShowEvent;
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 - Qt 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();
- ///
+ /// closes the view such that the view knows that is closed
+ /// programmatically and not by the user clicking the x.
+ bool closeScheduled();
+
+ /// Things that need to be done when the OSes session manager
+ /// requests a log out.
+ bool prepareAllBuffersForLogout();
+
int id() const { return id_; }
+
+ /// are we busy ?
+ bool busy() const;
+
+ /// Signal that the any "auto" minibuffer can be closed now.
+ void resetCommandExecute();
+
+ /// \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,
+ std::string templatefile = std::string(),
+ bool fromTemplate = false);
+
+ /// display a message in the view
+ /// could be called from any thread
+ void message(docstring const &);
+
+ bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
+ /// dispatch command.
+ /// \return true if the \c FuncRequest has been dispatched.
+ void dispatch(FuncRequest const & cmd, DispatchResult & dr);
+
+ void restartCaret();
+ /// 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 setBusy(bool);
- /// returns true if this view has the focus.
bool hasFocus() const;
+ ///
+ void focusInEvent(QFocusEvent * e);
+ /// Add a Buffer to the View
+ /// \param b Buffer to set.
+ /// \param switch_to Whether to set it to the current workarea.
+ void setBuffer(Buffer * b, bool switch_to = true);
+
+ /// 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();
- bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
- bool dispatch(FuncRequest const & cmd);
///
LayoutBox * getLayoutDialog() const;
- /// \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.
- /// closes the current active buffer
- bool closeBuffer();
/// hides the workarea and makes sure it is clean
bool hideWorkArea(GuiWorkArea * wa);
- /// closes the workarea
+ /// closes workarea; close buffer only if no other workareas point to it
bool closeWorkArea(GuiWorkArea * wa);
- /// 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?
+ /// closes the buffer
+ bool closeBuffer(Buffer & buf);
///
void openDocument(std::string const & filename);
///
void importDocument(std::string const &);
- ///
- void newDocument(std::string const & filename, bool fromTemplate);
- /// GuiBufferDelegate.
- ///@{
+ /// \name GuiBufferDelegate.
+ //@{
void resetAutosaveTimers();
+ // shows an error list
+ // if from_master is true, show master's error list
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();
- /// \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.
GuiWorkArea * workArea(Buffer & buffer);
+ /// \return the \c Workarea at index \c index
+ GuiWorkArea * workArea(int index);
- /// Add a \c WorkArea
+ /// Add a \c WorkArea
/// \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 document WorkArea (it may not have the focus).
GuiWorkArea * currentMainWorkArea();
+ /// Current ratio between physical pixels and device-independent pixels
+ double pixelRatio() const;
+
Q_SIGNALS:
void closing(int);
+ void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
+ // emitted when the work area or its buffer view changed
+ void bufferViewChanged();
public Q_SLOTS:
+ ///
+ void setBusy(bool);
/// idle timeout.
/// clear any temporary message and replace with current status.
void clearMessage();
-
-private Q_SLOTS:
///
void updateWindowTitle(GuiWorkArea * wa);
///
- void resetWindowTitleAndIconText();
+ void disableShellEscape();
+
+private Q_SLOTS:
+ ///
+ void resetWindowTitle();
+ ///
+ void checkCancelBackground();
///
void on_currentWorkAreaChanged(GuiWorkArea *);
///
+ void onBufferViewChanged();
+ ///
void on_lastWorkAreaRemoved();
- /// slots to change the icon size
- void smallSizedIcons();
- void normalSizedIcons();
- void bigSizedIcons();
+ /// 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();
+
+ ///
+ void toolBarPopup(const QPoint &pos);
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();
///
TabWorkArea * addTabWorkArea();
bool focusNextPrevChild(bool);
///
- struct GuiViewPrivate;
+ bool goToFileRow(std::string const & argument);
+
+ ///
+ class GuiViewPrivate;
GuiViewPrivate & d;
public:
void hideAll() const;
/// Update all visible dialogs.
- /**
+ /**
* Check the status of all visible dialogs and disable or reenable
* them as appropriate.
*
*/
void updateDialogs();
- /** \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.
void hideDialog(std::string const & name, Inset * inset);
///
void disconnectDialog(std::string const & name);
-
///
- void updateCompletion(Cursor & cur, bool start, bool keep);
+ bool develMode() const { return devel_mode_; }
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);
+ void initToolbar(std::string const & name);
+ /// Update lock (all) toolbars position
+ void updateLockToolbars();
+ ///
+ bool lfunUiToggle(std::string const & ui_component);
///
void toggleFullScreen();
///
- void insertLyXFile(docstring const & fname);
+ void insertLyXFile(docstring const & fname, bool ignorelang = false);
///
- void insertPlaintextFile(docstring const & fname,
- bool asParagraph);
+ /// Open Export As ... dialog. \p iformat is the format the
+ /// filter is initially set to.
+ bool exportBufferAs(Buffer & b, docstring const & iformat);
- /// Save a buffer as a new file.
+ ///
+ enum RenameKind {
+ LV_WRITE_AS,
+ LV_WRITE_AS_TEMPLATE,
+ LV_VC_RENAME,
+ LV_VC_COPY,
+ };
+ /// Get a path for LFUN_BUFFER_WRITE_AS_TEMPLATE
+ std::string const getTemplatesPath(Buffer & buf);
+ /// 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.
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);
+
+ \p kind controls what is done besides the pure renaming:
+ * LV_WRITE_AS => The buffer is written without version control actions.
+ * LV_VC_RENAME => The file is renamed in version control.
+ * LV_VC_COPY => The file is copied in version control.
+ */
+ bool renameBuffer(Buffer & b, docstring const & newname,
+ RenameKind kind = LV_WRITE_AS);
///
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);
/// closes the tabworkarea and all tabs. If we are in a close event,
/// all buffers will be closed, otherwise they will be hidden.
- /// main_work_area is the workarea marked in the session file as active.
bool closeTabWorkArea(TabWorkArea * twa);
- /// gives the user the possibility to save his work
+ /// 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 and all hidden buffers
- bool closeBufferAll();
/// closes all workareas
bool closeWorkAreaAll();
/// write all open workareas into the session file
/// 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,
PREVBUFFER
};
///
- void gotoNextOrPreviousBuffer(NextOrPrevious np);
-
- ///
- Inset * getOpenInset(std::string const & name) const;
+ void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
/// Is the dialog currently visible?
bool isDialogVisible(std::string const & name) const;
Dialog * findOrBuild(std::string const & name, bool hide_it);
///
Dialog * build(std::string const & name);
+ ///
+ bool reloadBuffer(Buffer & buffer);
+ ///
+ void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
+ ///
+ void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
+ ///
+ void showMessage();
/// This view ID.
int id_;
/// 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_;
+
+ /// Request to open the command toolbar if it is "auto"
+ bool command_execute_;
+ /// Request to give focus to minibuffer
+ bool minibuffer_focus_;
+
+ /// Statusbar widget that shows shell-escape status
+ QLabel * shell_escape_;
+ /// Statusbar widget that shows read-only status
+ QLabel * read_only_;
+ /// Statusbar widget that shows version control status
+ QLabel * version_control_;
+
+ /// The rate from which the actual zoom value is calculated
+ /// from the default zoom pref
+ double zoom_ratio_ = 1.0;
+ /// Minimum zoom percentage
+ static int const zoom_min_ = 10;
+
+ // movability flag of all toolbars
+ bool toolbarsMovable_;
+
+ // developer mode
+ bool devel_mode_;
+};
+
+
+class SEMenu : public QMenu
+{
+ Q_OBJECT
+public:
+ explicit SEMenu(QWidget * parent);
+
+public Q_SLOTS:
+ void showMenu(QPoint const &) { exec(QCursor::pos()); }
};
} // namespace frontend
projects / lyx.git / blobdiff