mapeditor.h
author insilmaril
Tue, 08 Apr 2008 08:28:37 +0000
changeset 681 4e558a15a804
parent 679 d2f72e448522
child 684 5f9a2771680d
permissions -rw-r--r--
1.11.7: Fixed hanging find function
     1 #ifndef MAPEDITOR_H
     2 #define MAPEDITOR_H
     3 
     4 #include <QGraphicsView>
     5 #include <QtNetwork>
     6 
     7 #include "attribute.h"
     8 #include "file.h"
     9 #include "misc.h"
    10 #include "parser.h"
    11 #include "ornamentedobj.h"
    12 #include "selection.h"
    13 #include "settings.h"
    14 #include "vymmodel.h"
    15 
    16 class VymModel;
    17 class Selection;
    18 
    19 /*! \brief Main widget in vym to display and edit a map */
    20 
    21 class MapEditor : public QGraphicsView, public XMLObj {
    22     Q_OBJECT
    23 
    24 public:
    25     /*! \brief State of the mapeditor 
    26 		
    27 		While a heading is edited, the state has to change, so
    28 		that e.g. no other object might get selected. This is done
    29 		in Main by calling setStateEditHeading
    30 	*/
    31 	enum State {
    32 		Idle,			//!< Idle, waiting for user event
    33 		EditHeading		//!< Editing heading (dont't select another branch now)
    34 	};
    35     /*! \brief Networking states
    36 		
    37 		In Network modus we want to switch of saveState, autosave, ...
    38 	*/
    39 	enum NetState {
    40 		Offline,			//!< Offline
    41 		Client,				//!< I am the client and connected to server
    42 		Server				//!< I am the server
    43 	};
    44     MapEditor(QWidget* parent=0);
    45 	~MapEditor();
    46 	VymModel* getModel();
    47 	QGraphicsScene * getScene();
    48 	State getState();					//!< Return State of MapEditor
    49 	void setStateEditHeading (bool);	//!< If set to true, State will change to EditHeading
    50 	bool isRepositionBlocked(); //!< While load or undo there is no need to update graphicsview
    51 	bool isSaveStateBlocked();			//!< block while undo/redo or while running scripts
    52 	void setSaveStateBlocked(bool);		//!< block saving the undo/redo state
    53 	bool isSelectBlocked();		//!< true, if no change of selection is possible, e.g. while editing the heading of abranch
    54 	
    55 protected:
    56 	/*! \brief Get name of object
    57 	  
    58 	  Returns heading of a branch or name of an object for use in comment
    59 	  of undo/redo history
    60 	*/ 
    61 	QString getName(const LinkableMapObj*);	// Get e.g. heading or filename
    62 	void makeTmpDirs();		// create temporary directories
    63 
    64 	/*! This function saves all information of the map to disc.
    65 	    saveToDir also calls the functions for all BranchObj and other objects in the map.
    66 		The structure of the map itself is returned as QString and passed back to Main, 
    67 		where saveToDir is called initially
    68 	*/	
    69     QString saveToDir (const QString &tmpdir, const QString &prefix, bool writeflags, const QPointF &offset, LinkableMapObj *saveSel);
    70 
    71 	/*! \brief Get directory, where current step in history is save
    72 
    73 		saveState creates a directory for each step in history. This function returns the
    74 		path of the current directory
    75 	*/
    76 	QString getHistoryDir();
    77 
    78 	/*! \brief Save the current changes in map 
    79 
    80 		Two commands and selections are saved:
    81 
    82 			- undocommand and undoselection to undo the change
    83 			- redocommand and redoselection to redo the action after an undo
    84 
    85 		Additionally a comment is logged. 
    86 
    87 	*/	
    88     void saveState(
    89 		const SaveMode& savemode, 
    90 		const QString &undoSelection, 
    91 		const QString &undoCommand, 
    92 		const QString &redoSelection, 
    93 		const QString &redoCommand, 
    94 		const QString &comment, 
    95 		LinkableMapObj *saveSelection);
    96 	/*! Overloaded for convenience */
    97     void saveStateChangingPart(
    98 		LinkableMapObj *undoSelection, 
    99 		LinkableMapObj* redoSelection, 
   100 		const QString &redoCommand, 
   101 		const QString &comment);
   102 	/*! Overloaded for convenience */
   103     void saveStateRemovingPart(
   104 		LinkableMapObj *redoSelection, 
   105 		const QString &comment);
   106 	/*! Overloaded for convenience */
   107     void saveState(
   108 		LinkableMapObj *undoSelection, 
   109 		const QString &undoCommand, 
   110 		LinkableMapObj *redoSelection, 
   111 		const QString &redoCommand, 
   112 		const QString &comment); 
   113 	/*! Overloaded for convenience */
   114     void saveState(
   115 		const QString &undoSelection, 
   116 		const QString &undoCommand, 
   117 		const QString &redoSelection, 
   118 		const QString &redoCommand, 
   119 		const QString &comment) ;
   120     void saveState(
   121 		const QString &undoCommand, 
   122 		const QString &redoCommand, 
   123 		const QString &comment) ;
   124 
   125 public:	
   126 
   127 	/* \brief Process one command and its parameters */
   128     void parseAtom (const QString &atom);	
   129 
   130 	/* \brief Runs the script */
   131 	void runScript (QString script);
   132 private:
   133     void addFloatImageInt(const QPixmap &img);
   134 
   135 public:
   136 	bool isDefault();		//!< true, if map is still the empty default map
   137     bool hasChanged();		//!< true, if something has changed and is not saved yet
   138 	void setChanged();		//!< called from TextEditor via LinkableMapObj
   139 	void closeMap();		//!< Closes the map
   140 
   141 	/*! \brief Sets filepath, filename and mapname
   142 
   143 	     If the filepath is "/home/tux/map.xml", then the filename will be set
   144 		 to map.xml. The destname is needed for vymLinks, pointing to another map. 
   145 		 The destname holds the real name of the file, after it has been compressed, e.g. "map.vym"
   146 	*/	 
   147 
   148 	/*! \brief Set File path
   149 
   150 	     The destname is needed to construct the references between maps
   151 	*/	 
   152 	void setFilePath (QString filepath,QString destname);	
   153 	void setFilePath (QString);	//!< Overloaded for convenience
   154 	QString getFilePath ();	//!< Full path e.g. "/home/tux/map.xml"
   155 	QString getFileName ();	//!< e.g. "map.xml"
   156 	QString getMapName ();	//!< e.g. "map"
   157 	QString getDestPath (); //!< e.g. "/home/tux/map.vym"
   158 
   159 	/*! \brief Load map
   160 
   161 		The data is read from file. Depending on LoadMode the current
   162 		selection gets replaced by data or the data is appended.
   163 	*/	
   164     ErrorCode load (QString, const LoadMode &, const FileType& );	// newmap, import/replace selection
   165 public:
   166 	/*! \brief Save the map to file */
   167     ErrorCode save(const SaveMode &);	
   168 	/* FIXME no needed any longer
   169 	void setZipped(bool);		//!< Set or unset compression of map with zip save map zipped
   170 	bool saveZipped();			//!< True, if file will be saved zipped
   171 	*/
   172     void print();				//!< Print the map
   173 	void setAntiAlias (bool);	//!< Set or unset antialiasing
   174 	void setSmoothPixmap(bool); //!< Set or unset smoothing of pixmaps
   175 private:
   176     QPixmap getPixmap();
   177 	void setHideTmpMode (HideTmpMode);	// temporary hide stuff
   178 	HideTmpMode getHideTmpMode();		// temporary hide stuff
   179 public:
   180 	/*! Set or unset temporary hiding of objects during export  */
   181 	void setExportMode (bool);
   182 
   183 	/*! Export as ASCII text to file */
   184 	void exportASCII (QString fname="",bool askForName=true);  
   185 
   186 	/*! Save as image */
   187     void exportImage (QString fname="",bool askForName=true,QString format="PNG");
   188 
   189     /*! Export as OpenOfficeOrg presentation */
   190     void exportOOPresentation(const QString &,const QString &);	
   191 
   192 	/*! Export as XHTML to directory */
   193     void exportXHTML(const QString& dir="", bool askForName=true);	
   194 
   195 	/*! Export as XTML to directory */
   196     void exportXML(QString dir="", bool askForName=true);
   197 
   198     void clear();						//!< Clear map
   199     void copy();						//!< Copy to clipboard
   200     void redo();						//!< Redo last action
   201 	bool isRedoAvailable();				//!< True, if redo is available
   202     void undo();						//!< Undo last action
   203 	bool isUndoAvailable();				//!< True, if undo is available
   204 	void gotoHistoryStep (int);			//!< Goto a specifig step in history
   205 private:	
   206     void addMapReplaceInt(const QString & undoSel, const QString & path);
   207     void addMapInsertInt (const QString & path, int pos);
   208     void pasteNoSave(const int &n);		//!< paste clipboard to branch
   209 public:	
   210     void paste();		//!< Paste clipboard to branch and backup
   211     void cut();			//!< Cut to clipboard (and copy)
   212 	/*! \brief Move absolutly
   213 
   214 		Move absolutly to (x,y).
   215 	*/	
   216     void move    (const double &x, const double &y);
   217 	/*! \brief Move relativly
   218 
   219 		Move relativly to (x,y).
   220 	*/	
   221     void moveRel (const double &x, const double &y);
   222     void moveBranchUp();	//!< Move branch up
   223     void moveBranchDown();	//!< Move branch down
   224 	void sortChildren();	//!< Sort children lexically
   225 private:	
   226 	void linkTo(const QString &);
   227 public:	
   228 	QString getHeading (bool &ok,QPoint &p); //!< Get heading, ok if selection is branch
   229 	void setHeading(const QString &);		//!< Set heading of branch	
   230 private:
   231 	void setHeadingInt(const QString &);
   232 	void setVymLinkInt(const QString &);	// Set vymLink for selection
   233 	/*! \brief Add new branch
   234 
   235 		Depending on num the new branch is created
   236 
   237 		-3 above selection as child of selections parent
   238 		-2 as child of selection
   239 		-1 below selection as child of selections parent
   240 		0..n	insert at a specific position in selections parent
   241 		(needed for free relinking)
   242 	*/	
   243     BranchObj* addNewBranchInt(int);		// pos allows to add above/below selection
   244 public:	
   245 	/*! \Add new branch
   246 		
   247 		Depending on num the new branch is created
   248 		-1 above selection
   249 		 0 as child of selection
   250 		 1 below selection
   251 	*/
   252     BranchObj* addNewBranch(int pos);		
   253     BranchObj* addNewBranchBefore();		//!< Insert branch between selection and its parent
   254     void deleteSelection();					//!< Delete selection
   255 	LinkableMapObj* getSelection();			//!< Returns selection
   256 	BranchObj* getSelectedBranch();			// returns selected branch or NULL
   257 	FloatImageObj* getSelectedFloatImage();	// returns selected branch or NULL
   258 	void unselect();						// before changing current noteedit
   259 	void reselect();						// after  changing current noteedit
   260 	bool select(const QString &);			// Select by string
   261 	QString getSelectString();
   262 private:	
   263 	void selectInt(LinkableMapObj*);	
   264 	void selectNextBranchInt();		// Increment number of branch
   265 	void selectPrevBranchInt();		// Decrement number of branch
   266 public:	
   267     void selectUpperBranch();
   268     void selectLowerBranch();
   269     void selectLeftBranch();
   270     void selectRightBranch();
   271     void selectFirstBranch();
   272     void selectLastBranch();
   273     void selectMapBackgroundImage();
   274     void setMapBackgroundImage(const QString &);
   275     void selectMapBackgroundColor();
   276     void setMapBackgroundColor(QColor);
   277     QColor getMapBackgroundColor();
   278     QColor getCurrentHeadingColor();
   279     void colorBranch(QColor);
   280     void colorSubtree(QColor);
   281 	void toggleStandardFlag(QString);
   282     BranchObj* findText(QString,bool);		// Find object
   283     void findReset();						// Reset Find 
   284 	void setURL(const QString &);			// set  URL
   285 	void editURL();							// edit URL
   286 	void editLocalURL();					// edit URL to local file
   287 	QString getURL();						// returns URL of selection or ""
   288 	QStringList getURLs();					// returns URLs of subtree
   289 	void editHeading2URL();					// copy heading to URL
   290 	void editBugzilla2URL();				// create URL to Bugzilla
   291 	void editFATE2URL();					// create URL to FATE
   292 	void editVymLink();						// edit link to another map
   293 	void deleteVymLink();					// delete link to another map
   294 	QString getVymLink();					// return path to map
   295 	QStringList getVymLinks();				// return paths in subtree
   296 	void setHideExport(bool);				// toggle the export flag
   297 	void toggleHideExport();				// toggle the export flag
   298 	void deleteKeepChilds();				// remove but keep childs
   299 	void deleteChilds();					// remove childs
   300 	void editMapInfo();						// dialog to enter author, ...
   301 	void ensureSelectionVisible();		
   302 	void updateSelection();					// update geometry of selection
   303 	void updateActions();					// update e.g. format buttons
   304 	void updateNoteFlag();					// when TextEditor changes
   305 	void setMapAuthor (const QString &);
   306 	void setMapComment(const QString &);
   307 	void setMapLinkStyle (const QString &);	// Set style of link
   308 	LinkableMapObj::Style getMapLinkStyle ();	// requested in LMO
   309 	void setMapDefLinkColor(QColor);		// default color of links
   310 	void setMapLinkColorHintInt();			// color of links
   311 	void setMapLinkColorHint(LinkableMapObj::ColorHint);// color of links
   312 	LinkableMapObj::ColorHint getMapLinkColorHint();
   313 	QColor getMapDefLinkColor();
   314 	void setMapDefXLinkColor(QColor);
   315 	QColor getMapDefXLinkColor();
   316 	void setMapDefXLinkWidth (int);
   317 	int getMapDefXLinkWidth();
   318 	void toggleMapLinkColorHint();			// after changing linkStyles
   319     void selectMapLinkColor();
   320     void selectMapSelectionColor();
   321 private:	
   322     void setSelectionColorInt(QColor);
   323 public:	
   324     void setSelectionColor(QColor);
   325     QColor getSelectionColor();
   326 	bool scrollBranch(BranchObj*);
   327 	bool unscrollBranch(BranchObj*);
   328     void toggleScroll();
   329     void unscrollChilds();
   330 private:	
   331 	FloatImageObj* loadFloatImageInt (QString);
   332 public:	
   333 	void loadFloatImage ();
   334 private:	
   335 	void saveFloatImageInt (FloatImageObj*, const QString &, const QString &);
   336 public:	
   337 	void saveFloatImage ();
   338 	void setFrameType(const FrameObj::FrameType &);
   339 	void setFrameType(const QString &);
   340 	void setFramePenColor (const QColor &);
   341 	void setFrameBrushColor (const QColor &);
   342 	void setFramePadding (const int &);
   343 	void setFrameBorderWidth (const int &);
   344 	void setIncludeImagesVer(bool);
   345 	void setIncludeImagesHor(bool);
   346 	void setHideLinkUnselected (bool);
   347 	bool getHideLinkUnselected ();
   348 private:	
   349     void importDirInt(BranchObj *,QDir);
   350     void importDirInt(const QString&);
   351 public:	
   352     void importDir();
   353 	void followXLink (int);
   354 	void editXLink (int);
   355 	AttributeTable* attributeTable();
   356     void testFunction1();					// just testing new stuff
   357     void testFunction2();					// just testing new stuff
   358 											// set /mainwindo/showTestMenu=true...
   359 
   360 protected:
   361 	virtual void contextMenuEvent ( QContextMenuEvent *e );
   362     virtual void keyPressEvent(QKeyEvent*);
   363     virtual void keyReleaseEvent(QKeyEvent*);
   364     virtual void mousePressEvent(QMouseEvent*);
   365     virtual void mouseMoveEvent(QMouseEvent*);
   366     virtual void mouseReleaseEvent(QMouseEvent*);
   367     virtual void mouseDoubleClickEvent(QMouseEvent*);
   368     virtual void resizeEvent( QResizeEvent * );
   369 
   370 	void dragEnterEvent (QDragEnterEvent *);
   371 	void dragMoveEvent (QDragMoveEvent *);
   372 	void dragLeaveEvent (QDragLeaveEvent *);
   373 	void dropEvent (QDropEvent *);
   374 
   375 	void timerEvent(QTimerEvent *event);
   376 
   377 protected:
   378 	void sendSelection();
   379 
   380 public:
   381 	void newServer();
   382 	void connectToServer();
   383 
   384 private slots:	
   385 	void newClient();
   386 	void sendData(const QString &s);
   387 	void readData();
   388 	void displayNetworkError (QAbstractSocket::SocketError);
   389 
   390 	void autosave ();
   391 	void fileChanged();
   392 
   393 private:
   394 	State state;				// State of MapEditor
   395 	QGraphicsScene *mapScene;
   396 	VymModel *model;					// Vym Map, includding several mapCenters
   397 	QTimer *autosaveTimer;
   398 	QTimer *fileChangedTimer;
   399 	QDateTime fileChangedTime;
   400 
   401 	bool adjustCanvasRequested;	// collect requests until end of user event
   402 	BranchObj *editingBO;		// entering Text into BO
   403 
   404 	QColor defLinkColor;		// default color for links
   405 	QColor defXLinkColor;		// default color for xlinks
   406 	int defXLinkWidth;			// default width for xlinks
   407 	LinkableMapObj::ColorHint linkcolorhint;// use heading color or own color
   408 	LinkableMapObj::Style linkstyle;		// default style for links
   409 
   410     QCursor HandOpenCursor;		// cursor while moving canvas view
   411 	QCursor PickColorCursor;	// cursor while picking color 
   412 	QCursor CopyCursor;			// cursor while picking color 
   413 	QCursor XLinkCursor;		// cursor while picking color 
   414 	bool pickingColor;
   415 	bool drawingLink;			// true while creating a link
   416 	bool copyingObj;			// true while creating a link
   417 	XLinkObj* tmpXLink;
   418 
   419 	Selection xelection;	
   420 
   421 	QString latestSelection;		// select string of latest added object
   422 
   423     MapObj* movingObj;				// moving a MapObj
   424 	MapObj* linkingObj_src;			// part of a link
   425     QPointF movingObj_orgPos;		// org. pos of mouse before move
   426     QPointF movingObj_orgRelPos;	// org. relative pos of mouse before move
   427     QPointF movingObj_start;		// rel. pos of mouse to absPos 
   428     QPointF movingCont_start;		// inital pos of moving Content or
   429     QPointF movingVec;				// how far has Content moved
   430     QPrinter* printer;				// Printing
   431 
   432     bool mapDefault;				// Flag if map is untouched
   433     bool mapChanged;				// Flag if undo is possible
   434 	bool mapUnsaved;				// Flag if map should be saved
   435 
   436 	Parser parser;				// Parser stuff for scripting
   437 
   438 	AttributeTable *attrTable;
   439 
   440 	bool printFrame;			// Print frame around map
   441 	bool printFooter;			// Print footer below map
   442 
   443 	bool zipped;				// should map be zipped
   444 	static	int mapNum;			// unique number for Editor
   445 	FileType fileType;			// type of file, e.g. vym, freemind...
   446 	QString fileName;			// short name of file (for tab)
   447 	QString filePath;			// path to file which will be saved
   448 	QString fileDir;			// dir where file is saved
   449 	QString destPath;			// path to .vym file (needed for vymlinks)
   450 	QString mapName;			// fileName without ".vym"
   451 
   452 	QString tmpMapDir;			// tmp directory with undo history
   453 	QString histPath;			// Path to history file
   454 	SimpleSettings undoSet;		// undo/redo commands, saved in histPath
   455 	int stepsTotal;				// total number of steps (undos+redos) 
   456 	int curStep;				// Current step in history (ring buffer)
   457 	int curClipboard;			// number of history step, which is the current clipboard
   458 	int redosAvail;				// Available number of redo steps
   459 	int undosAvail;				// Available number of undo steps
   460 	bool blockReposition;		// block while load or undo
   461 	bool blockSaveState;		// block while load or undo
   462 
   463 	BranchObj* itFind;			// next object in find process
   464 	bool EOFind;				// true, if search failed
   465 
   466 	QPoint exportOffset;		// set before export, used in save
   467 	HideTmpMode hidemode;	// true while exporting to hide some stuff
   468 
   469 	// Network connections **Experimental**
   470 	NetState netstate;			// offline, client, server
   471 	QTcpServer *tcpServer;		// Act as server in conference mode (experimental)
   472 	QList <QTcpSocket*> clientList;		// List of connected clients
   473 	quint16 sendCounter;		// Increased with every sent command
   474 
   475 	QTcpSocket	*clientSocket;	// socket of this client
   476 	QString server;				// server address of this client
   477 	int port;					// server port of this client
   478 	void displayClientError(QAbstractSocket::SocketError socketError);
   479 
   480 
   481 	// Animation data **experimental**
   482 	int timerId;				// animation timer
   483 	QList <MapObj*> animObjList;// list with animated objects
   484 };
   485 #endif
   486