scribus.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
/***************************************************************************
                          scribus.h  -  description
                             -------------------
    begin                : Fre Apr  6 21:09:31 CEST 2001
    copyright            : (C) 2001 by Franz Schmid
    email                : Franz.Schmid@altmuehlnet.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SCRIBUS_H
#define SCRIBUS_H

#define VERS13x

// include from stl
#include <vector>

// include files for QT

#include <QActionGroup>
#include <QClipboard>
#include <QKeyEvent>
#include <QMainWindow>
#include <QMap>
#include <QMultiHash>
#include <QPixmap>
#include <QPointer>
#include <QPushButton>
#include <QProcess>
#include <QString>

class QCloseEvent;
class QDragEnterEvent;
class QDropEvent;
class QEvent;
class QKeyEvent;
class QLabel;
class QMdiArea;
class QMdiSubWindow;
class QQuickView;

// application specific includes
#include "scribusapi.h"
#include "scribusdoc.h"
#include "styleoptions.h"
#include "ui/customfdialog.h"
#include "ui/scmessagebox.h"

class ActionManager;
class AlignDistributePalette;
class AppModeHelper;
class Autoforms;
class Biblio;
class BookPalette;
class CharSelect;
class CheckDocument;
class ColorCombo;
class DownloadsPalette;
class EditToolBar;
class FileToolBar;
class FontCombo;
class FormatsManager;
class GuideManager;
class HelpBrowser;
class InlinePalette;
class LayerPalette;
class MarksManager;
class Measurements;
class ModeToolBar;
class NodePalette;
class NotesStylesEditor;
class OutlinePalette;
class PDFToolBar;
class PSLib;
class PageItem;
class PagePalette;
class PageSelector;
class PrefsContext;
class PrefsManager;
class PropertiesPalette;
class ResourceManager;
class ScMWMenuManager;
class ScToolBar;
class ScrAction;
class ScrSpinBox;
class ScribusCore;
class ScribusDoc;
class ScribusMainWindow;
class ScribusQApp;
class ScribusWin;
class SimpleState;
class StoryEditor;
class StyleManager;
class SymbolPalette;
class TOCGenerator;
class UndoManager;
class UndoPalette;
class UndoState;
class ViewToolBar;

extern SCRIBUS_API ScribusQApp* ScQApp;

class SCRIBUS_API ScribusMainWindow : public QMainWindow, public UndoObject
{
    Q_OBJECT

public:
    ScribusMainWindow();
    ~ScribusMainWindow();
    int initScMW(bool primaryMainwWindow);
    void addScToolBar(ScToolBar *tb, QString name);
    bool warningVersion(QWidget *parent);
    void SetShortCut();
    void startUpDialog();
    void setDefaultPrinter(const QString&, const QString&, const QString&);
    void getDefaultPrinter(QString& name, QString& file, QString& command);

    inline bool scriptIsRunning(void) const { return (ScriptRunning > 0); }
    inline void setScriptRunning(bool value) { ScriptRunning += (value ? 1 : -1); }

    ScribusDoc *doFileNew(double width, double height, double topMargin, double leftMargin, double rightMargin, double bottomMargin, double columnDistance, double columnCount, bool autoTextFrames, int pageArrangement, int unitIndex, int firstPageLocation, int orientation, int firstPageNumber, const QString& defaultPageSize, bool requiresGUI, int pageCount=1, bool showView=true, int marginPreset=0);
    ScribusDoc *newDoc(double width, double height, double topMargin, double leftMargin, double rightMargin, double bottomMargin, double columnDistance, double columnCount, bool autoTextFrames, int pageArrangement, int unitIndex, int firstPageLocation, int orientation, int firstPageNumber, const QString& defaultPageSize, bool requiresGUI, int pageCount=1, bool showView=true, int marginPreset=0);
    bool DoFileSave(const QString& fileName, QString* savedFileName = NULL);
    void changeEvent(QEvent *e);
    void closeEvent(QCloseEvent *ce);
    void keyPressEvent(QKeyEvent *k);
    void keyReleaseEvent(QKeyEvent *k);
    void inputMethodEvent ( QInputMethodEvent * event );
    QVariant inputMethodQuery ( Qt::InputMethodQuery query ) const ;
    void requestUpdate(int);
    void setTBvals(PageItem *currItem);
    int ShowSubs();
    void applyNewMaster(QString name);
    void updateRecent(QString fn);
    void doPasteRecent(QString data);
    bool getPDFDriver(const QString & filename, const QString & name, int components, const std::vector<int> & pageNumbers, const QMap<int,QPixmap> & thumbs, QString& error, bool* cancelled = NULL);
    bool DoSaveAsEps(QString fn, QString& error);
    QString CFileDialog(QString workingDirectory = ".", QString dialogCaption = "", QString fileFilter = "", QString defNa = "",
                        int optionFlags = fdExistingFiles, bool *useCompression = 0, bool *useFonts = 0, bool *useProfiles = 0);
    void recalcColors(QProgressBar *dia = 0);
    void SwitchWin();
    void RestoreBookMarks();
    QStringList  scrapbookNames();
    void updateLayerMenu();
    void emergencySave();

    bool arrowKeyDown();
    bool isObjectSpecificUndo();
    void restore(UndoState* state, bool isUndo);
    void restoreGrouping(SimpleState *state, bool isUndo);
    void restoreUngrouping(SimpleState *state, bool isUndo);
    void restoreAddPage(SimpleState *state, bool isUndo);
    void restoreDeletePage(SimpleState *state, bool isUndo);
    void setPreviewToolbar();
    struct CopyContentsBuffer contentsBuffer;
    bool internalCopy;
    QString internalCopyBuffer;
    int  HaveDoc;
    PrefsContext* dirs;
    ScribusView *view;
    ScribusDoc *doc;
    ScribusDoc* m_doc;


    QProgressBar* mainWindowProgressBar;
    ScrSpinBox* zoomSpinBox; //zoom spinbox at bottom of view
    PageSelector* pageSelector; //Page selector at bottom of view
    QPushButton *zoomDefaultToolbarButton;
    QPushButton *zoomOutToolbarButton;
    QPushButton *zoomInToolbarButton;
    QComboBox *layerMenu; //Menu for layers at bottom of view
    QComboBox *unitSwitcher; //Menu for units at bottom of view
    EditToolBar *editToolBar;
    FileToolBar *fileToolBar;
    ModeToolBar* modeToolBar;
    PDFToolBar* pdfToolBar;
    ViewToolBar* viewToolBar;
    QLabel* mainWindowXPosLabel;
    QLabel* mainWindowXPosDataLabel;
    QLabel* mainWindowYPosLabel;
    QLabel* mainWindowYPosDataLabel;
    GuideManager *guidePalette;
    CharSelect *charPalette;
    PropertiesPalette *propertiesPalette;
    MarksManager *marksManager;
    NotesStylesEditor *nsEditor;
    NodePalette *nodePalette;
    OutlinePalette *outlinePalette;
    Biblio *scrapbookPalette;
    LayerPalette* layerPalette;
    PagePalette *pagePalette;
    BookPalette *bookmarkPalette;
    DownloadsPalette *downloadsPalette;
    SymbolPalette *symbolPalette;
    InlinePalette *inlinePalette;
    Measurements* measurementPalette;
    CheckDocument * docCheckerPalette;
    UndoPalette* undoPalette;
    AlignDistributePalette *alignDistributePalette;
    ResourceManager *resourceManager;
    StoryEditor* storyEditor;
    StoryEditor* CurrStED;
    QMdiArea *mdiArea;
    ScribusWin* ActWin;
    QClipboard *ClipB;
    QString LoadEnc;
    AppModeHelper *appModeHelper;

    QProcess *ExternalApp;

    QMap<QString, QPointer<ScrAction> > scrActions;
    QMap<QString, QPointer<ScrAction> > scrRecentFileActions;
    QMap<QString, QPointer<ScrAction> > scrWindowsActions;
    QMap<QString, QPointer<ScrAction> > scrScrapActions;
    QMap<QString, QPointer<ScrAction> > scrLayersActions;
    QMap<QString, QPointer<ScrAction> > scrRecentPasteActions;
    QMap<QString, QPointer<ScToolBar> > scrToolBars;
    QMultiHash<QString, QActionGroup*> scrActionGroups;
    ScMWMenuManager* scrMenuMgr;
    ActionManager* actionManager;
    QStringList RecentDocs;
    QStringList patternsDependingOnThis;

public slots:
    void languageChange();
    void statusBarLanguageChange();
    void specialActionKeyEvent(int unicodevalue);
    void newView();
    void ToggleStickyTools();
    void ToggleAllGuides();
    void ToggleAllPalettes();
    void slotStoryEditor(bool fromTable);
    void slotCharSelect();
    void ImageEffects();
    QString fileCollect(const bool compress = false, const bool withFonts = false, const bool withProfiles = false, const QString& newDirectory=QString::null);
    void AddBookMark(PageItem *ite);
    void DelBookMark(PageItem *ite);
    void BookMarkTxT(PageItem *ite);
    void StoreBookmarks();
    void setStatusBarMousePosition(double xp, double yp);
    void setStatusBarTextPosition(double base, double xp);
    void setStatusBarTextSelectedItemInfo();
    void setTempStatusBarText(const QString &text);
    void setStatusBarInfoText(QString newText);
    bool DoFileClose();
    void windowsMenuAboutToShow();
    void extrasMenuAboutToShow();
    void newActWin(QMdiSubWindow *w);
    void closeActiveWindowMasterPageEditor();
    void updateActiveWindowCaption(const QString &newCaption);
    void windowsMenuActivated(int id);
    void PutScrap(int scID);
    void PutToInline(QString buffer);
    void PutToInline();
    void PutToPatterns();
    void ConvertToSymbol();
    void changeLayer(int);
    void setLayerMenuText(const QString &);
    void showLayer();
    void slotSetCurrentPage(int Seite);
    void setCurrentPage(int p);
    void ManageJava();
    void editSelectedSymbolStart();
    void editSymbolStart(QString temp);
    void editSymbolEnd();
    void editInlineStart(int id);
    void editInlineEnd();
    void editMasterPagesStart(QString temp = "");
    void editMasterPagesEnd();
    bool slotFileNew();
    void newFileFromTemplate();
    bool slotPageImport();
    bool loadPage(QString fileName, int Nr, bool Mpa, const QString& renamedPageName=QString::null);
    void GotoLa(int l);
    void slotGetContent();
    void slotGetContent2(); // kk2006
    void slotGetClipboardImage();
    void toogleInlineState();
    void slotFileAppend();

    void removeRecent(QString fn, bool fromFileWatcher = false);
    void removeRecentFromWatcher(QString filename);
    void loadRecent(QString filename);
    void rebuildRecentFileMenu();
    void rebuildRecentPasteMenu();
    void rebuildScrapbookMenu();
    void pasteRecent(QString fn);
    void pasteFromScrapbook(QString fn);
    void importVectorFile();
    void rebuildLayersList();
    bool slotFileOpen();
    bool loadDoc(QString);
    bool postLoadDoc();
    void slotAutoSaved();
    bool slotFileSave();
    bool slotFileSaveAs();
    void slotFileRevert();
    void SaveText();
    bool slotFileClose();
    void slotFilePrint();
    void slotReallyPrint();
    void slotEndSpecialEdit();
    bool doPrint(PrintOptions &options, QString& error);
    void slotFileQuit();
    void slotEditCut();
    void slotEditCopy();
    void slotEditPaste();
    void slotEditCopyContents();
    void slotEditPasteContents(int absolute=0);
    void EnableTxEdit();
    void DisableTxEdit();
    void SelectAll(bool docWideSelect=false);
    void SelectAllOnLayer();
    void deselectAll();
    void ClipChange();
    void slotHelpAbout();
    void slotHelpAboutPlugins();
    void slotHelpAboutQt();
    void slotHelpCheckUpdates();
    void slotRaiseOnlineHelp();
    void slotOnlineHelp(const QString & jumpToSection=QString::null, const QString & jumpToFile=QString::null);
    void slotOnlineHelpClosed();
    void slotResourceManager();
    void ToggleTips();
    void ToggleMouseTips();
    void slotNewPageP(int wo, QString templ);
    void slotNewPageM();
    void slotNewMasterPage(int w, const QString &);
    void slotNewPage(int w, const QString& masterPageName=QString::null, bool mov = true);
    void duplicateToMasterPage();
    void deletePage();
    void deletePage(int from, int to);
    void deletePage2(int pg);
    void movePage();
    void copyPage();
    void changePageProperties();
    void slotZoom(double zoomFactor); // 20, 50, 100, or -100 for Fit
    void toggleMarks();
    void toggleBleeds();
    void toggleFrames();
    void toggleLayerMarkers();
    void toggleTextLinks();
    void toggleTextControls();
    void toggleColumnBorders();
    void toggleRulers();
    void toggleRulerMode();
    void togglePagePalette();
    void toggleUndoPalette();
    void setUndoPalette(bool visible);
    void toggleCheckPal();
    void toggleImageVisibility();
    void toggleGrid();
    void toggleSnapGrid();
    void toggleNodeEdit();
    void slotSelect();
    //void setAppMode(int mode);
    void setAppModeByToggle(bool isOn, int newMode);
    void HaveNewDoc();
    void HaveNewSel();
    void slotDocCh(bool reb = true);
    //void setItemShade(int id);
    void SetNewFont(const QString& nf);
    void setItemFontSize(int fontSize);
    void slotReplaceColors();
    void MakeFrame(int f, int c, double *vals);
    void duplicateItem();
    void duplicateItemMulti();

    void objectAttributes();
    void getImageInfo();
    void generateTableOfContents();
    void updateDocument();

//  void saveStyles(StilFormate *dia); //still required for style save from SE
    void setNewAlignment(int a);
    void setNewParStyle(const QString& name);
    void setNewCharStyle(const QString& name);
    void setAlignmentValue(int a);
    void editItemsFromOutlines(PageItem *ite);
    //0= center, 1 = top left.
    void selectItemsFromOutlines(PageItem *ite, bool single = false, int position = 0);
    void selectItemFromOutlines(PageItem *ite, bool single, int cPos);
    void selectPagesFromOutlines(int ScPage);
    void doPrintPreview();
    void printPreview();
    void SaveAsEps();
    void reallySaveAsEps();
    void SaveAsPDF();
    void doSaveAsPDF();
    void setMainWindowActive();
    void setItemEffects(int h);
    void setStyleEffects(int s);
    void setItemTypeStyle(int id);
    void slotElemRead(QString Name, double x, double y, bool art, bool loca, ScribusDoc* docc, ScribusView* vie);
    void slotChangeUnit(int art, bool draw = true);
    void ApplyMasterPage();
    void Apply_MasterPage(QString pageName, int pageNumber, bool reb = true);
    void GroupObj(bool showLockDia = true);
    void UnGroupObj();
    void AdjustGroupObj();
    void StatusPic();
    void ModifyAnnot();
    void toggleGuides();
    void toggleBase();
    void toggleSnapGuides();
    void toggleSnapElements();
    void SetSnapElements(bool b);
    void EditTabs();
    void SearchText();
    void imageEditorExited(int, QProcess::ExitStatus);
    void callImageEditor();
    void docCheckToggle(bool visible);
    bool scanDocument();
    void setUndoMode(bool isObjectSpecific);
    void insertSampleText();
    void updateItemLayerList();
    void updateColorLists();
    void slotPrefsOrg();
    void slotDocSetup();
    void slotInsertFrame();
    void slotItemTransform();
    void managePaints();
    StyleManager *styleMgr() const {return styleManager;};
    void updateGUIAfterPagesChanged();
    void updateTableMenuActions();
    void emitUpdateRequest(int updateFlags) { emit UpdateRequest(updateFlags); }

    //inserting marks
    void slotInsertMark2Mark() { insertMark(MARK2MarkType); }
    void slotInsertMarkAnchor() { insertMark(MARKAnchorType); }
    void slotInsertMarkVariableText() { insertMark(MARKVariableTextType); }
    void slotInsertMarkItem() { insertMark(MARK2ItemType); }
    void slotInsertMarkNote();
    void slotInsertMarkIndex() { insertMark(MARKIndexType); }
    void slotEditMark();
    //connected to signal emited by actions when "Update Marks" menu item is triggered
    void slotUpdateMarks();
    bool editMarkDlg(Mark *mrk, PageItem_TextFrame* currItem = NULL);
    void testQTQuick2_1();
    void testQT_slot1(QString);
    void testQT_slot2(double);
    void testQT_slot3(int);
    void testQT_slot4();
    //void adjustCMS();
    void changePreviewQuality(int index);
    void enablePalettes(bool b);
    void ToggleFrameEdit();
    void NoFrameEdit();

signals:
    //void AppModeChanged(int oldMode, int newMode);
    void TextStyle(const ParagraphStyle&);
//deprecated: (av)
    void TextEffects(int);
    void UpdateRequest(int updateFlags);
    void changeLayers(int);

protected:
    bool eventFilter( QObject *o, QEvent *e );
    virtual void dragEnterEvent( QDragEnterEvent* e);
    virtual void dropEvent( QDropEvent* e);

private:
    void initSplash(bool showSplash);
    void initMenuBar(); // initMenuBar creates the menu_bar and inserts the menuitems
    void createMenuBar();
    void addDefaultWindowMenuItems(); // addDefaultWindowMenuItems adds the basic Windows menu items, excluding the actual list of windows
    void initStatusBar(); // setup the statusbar
    void initToolBars(); // setup the toolbars
    void setStyleSheet(); //set stylesheet for app
    //Returns false when there are no fonts
    void initHyphenator();
    void initDefaultValues();
    void initKeyboardShortcuts();
    void initPalettes();
    void initScrapbook();

    void updateColorMenu(QProgressBar* progressBar=NULL);

    int ScriptRunning;

    QLabel* mainWindowStatusLabel;
    QString statusLabelText;
    //QPixmap noIcon;

    int toolbarMenuTools;
    int toolbarMenuPDFTools;
    int viewToolbars;
    int viewPropertiesPalette;
    int viewOutlinePalette;
    int viewNodePalette;
    int viewBpal;
    int viewLayerPalette;
    int viewPagePalette;
    int viewBopal;
    int viewUndoPalette;

    bool palettesStatus[11];
    bool guidesStatus[13];

    bool keyrep;
    bool _arrowKeyDown;
    bool objectSpecificUndo;

    //CB: #8212: add overrideMasterPageSizing, however default to true for compatibility with other calls.. for now
    void addNewPages(int wo, int where, int numPages, double height, double width, int orient, QString siz, bool mov, QStringList* basedOn = 0, bool overrideMasterPageSizing=true);

    int DocNr;
    bool PrinterUsed;
    struct PDe {
                    QString Pname;
                    QString Dname;
                    QString Command;
                } PDef ;
    TOCGenerator *tocGenerator;
    int storedPageNum;
    int storedViewXCoor;
    int storedViewYCoor;
    double storedViewScale;
    StyleManager *styleManager;
    UndoManager *undoManager;
    PrefsManager *prefsManager;
    FormatsManager *formatsManager;

    QPointer<HelpBrowser> helpBrowser;
    QString osgFilterString;

    void insertMark(MarkType);
    bool insertMarkDialog(PageItem_TextFrame* item, MarkType mT, ScItemsState* &is);
    int m_marksCount; //remember marks count from last call
    bool m_WasAutoSave;
    bool m_pagePalVisible;

    QQuickView *qqview;
};

#endif