vymmodel.h
author insilmaril
Wed, 04 Feb 2009 16:33:16 +0000
changeset 740 6dc0a20031f7
parent 739 3d43b46a8564
child 741 1b4d1ea6ea8c
permissions -rw-r--r--
started to rewrite first(), next()
     1 #ifndef VYMMODEL_H
     2 #define VYMMODEL_H
     3 
     4 #include <QGraphicsScene>
     5 #include <QtNetwork>
     6 
     7 #include "file.h"
     8 #include "mapcenterobj.h"
     9 #include "mapeditor.h"
    10 #include "parser.h"
    11 #include "selection.h"
    12 #include "treeitem.h"
    13 #include "treemodel.h"
    14 
    15 class VymModel : public TreeModel {		
    16 	Q_OBJECT
    17 
    18 ////////////////////////////////////////////
    19 // General housekeeping
    20 ////////////////////////////////////////////
    21 private:
    22 	QGraphicsScene *mapScene;
    23 	QList <MapCenterObj*> mapCenters;
    24 	QString version;	//!< version string saved in vym file
    25 	QString author;
    26 	QString comment;
    27 	QDate date;
    28 
    29 public:
    30 	VymModel();
    31 	~VymModel ();
    32     void clear();
    33     void init();
    34 	void makeTmpDirectories();		//!< create temporary directories e.g. for history
    35 
    36 	MapEditor* getMapEditor();			// FIXME not necessary
    37 
    38 	bool isRepositionBlocked();		//!< While load or undo there is no need to update graphicsview
    39 
    40 	void updateActions();			//!< Update buttons in mainwindow
    41 
    42 
    43 ////////////////////////////////////////////
    44 // Load/save 
    45 ////////////////////////////////////////////
    46 private:
    47 
    48 	bool zipped;				// should map be zipped
    49 	static	int mapNum;			// unique number for model used in save/undo
    50 	FileType fileType;			// type of file, e.g. vym, freemind...
    51 	QString fileName;			// short name of file (for tab)
    52 	QString filePath;			// path to file which will be saved
    53 	QString fileDir;			// dir where file is saved
    54 	QString destPath;			// path to .vym file (needed for vymlinks)
    55 	QString mapName;			// fileName without ".vym"
    56 
    57 	QString tmpMapDir;			// tmp directory with undo history
    58 
    59 	QTimer *autosaveTimer;
    60 	QTimer *fileChangedTimer;
    61 	QDateTime fileChangedTime;
    62 
    63 public:
    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 Sets filepath, filename and mapname
    72 
    73 	     If the filepath is "/home/tux/map.xml", then the filename will be set
    74 		 to map.xml. The destname is needed for vymLinks, pointing to another map. 
    75 		 The destname holds the real name of the file, after it has been compressed, e.g. "map.vym"
    76 	*/	 
    77 
    78 
    79 	/*! \brief Set File path
    80 
    81 	     The destname is needed to construct the references between maps
    82 	*/	 
    83 	void setFilePath (QString filepath,QString destname);	
    84 	void setFilePath (QString);	//!< Overloaded for convenience
    85 	QString getFilePath ();	//!< Full path e.g. "/home/tux/map.xml"
    86 	QString getFileName ();	//!< e.g. "map.xml"
    87 	QString getMapName ();	//!< e.g. "map"
    88 	QString getDestPath (); //!< e.g. "/home/tux/map.vym"
    89 
    90 	/*! \brief Load map
    91 
    92 		The data is read from file. Depending on LoadMode the current
    93 		selection gets replaced by data or the data is appended.
    94 	*/	
    95     ErrorCode load (QString, const LoadMode &, const FileType& );	// newmap, import/replace selection
    96 
    97 public:
    98 	/*! \brief Save the map to file */
    99     ErrorCode save(const SaveMode &);	
   100 
   101 private:
   102     void addMapReplaceInt(const QString & undoSel, const QString & path);
   103     void addMapInsertInt (const QString & path, int pos);
   104 
   105 	FloatImageObj* loadFloatImageInt (QString);
   106 	void saveFloatImageInt (FloatImageObj*, const QString &, const QString &);
   107 public:	
   108 	void loadFloatImage ();
   109 	void saveFloatImage ();
   110 
   111 private:	
   112     void importDirInt(BranchObj *,QDir);
   113     void importDirInt(const QString&);
   114 public:	
   115     void importDir();
   116 
   117 private slots:
   118 	void autosave ();
   119 	void fileChanged();
   120 
   121 ////////////////////////////////////////////
   122 // history (undo/redo)
   123 ////////////////////////////////////////////
   124 private:
   125     bool mapDefault;			//!< Flag if map is untouched
   126     bool mapChanged;			//!< Flag if undo is possible
   127 	bool mapUnsaved;			//!< Flag if map should be saved
   128 
   129 	QString histPath;			//!< Path to history file
   130 	SimpleSettings undoSet;		//!< undo/redo commands, saved in histPath
   131 	int stepsTotal;				//!< total number of steps (undos+redos) 
   132 	int curStep;				//!< Current step in history (ring buffer)
   133 	int curClipboard;			//!< number of history step, which is the current clipboard
   134 	int redosAvail;				//!< Available number of redo steps
   135 	int undosAvail;				//!< Available number of undo steps
   136 	bool blockReposition;		//!< block while load or undo
   137 	bool blockSaveState;		//!< block while load or undo
   138 public:
   139 	bool isDefault();			//!< true, if map is still the empty default map
   140 	void makeDefault();			//!< Reset changelog, declare this as default map
   141     bool hasChanged()	;		//!< true, if something has changed and is not saved yet
   142 	void setChanged();			//!< called from TextEditor via LinkableMapObj
   143 
   144 	/*! \brief Get name of object
   145 	  
   146 	  Returns heading of a branch or name of an object for use in comment
   147 	  of undo/redo history
   148 	*/ 
   149 	QString getObjectName(const LinkableMapObj*);	
   150 
   151     void redo();						//!< Redo last action
   152 	bool isRedoAvailable();				//!< True, if redo is available
   153     void undo();						//!< Undo last action
   154 	bool isUndoAvailable();				//!< True, if undo is available
   155 	void gotoHistoryStep (int);			//!< Goto a specifig step in history
   156 
   157 
   158 	QString getHistoryPath();			//!< Path to directory containing the history
   159 
   160 	/*! \brief Save the current changes in map 
   161 
   162 		Two commands and selections are saved:
   163 
   164 			- undocommand and undoselection to undo the change
   165 			- redocommand and redoselection to redo the action after an undo
   166 
   167 		Additionally a comment is logged. 
   168 
   169 	*/	
   170     void saveState(
   171 		const SaveMode& savemode, 
   172 		const QString &undoSelection, 
   173 		const QString &undoCommand, 
   174 		const QString &redoSelection, 
   175 		const QString &redoCommand, 
   176 		const QString &comment, 
   177 		LinkableMapObj *saveSelection);
   178 	/*! Overloaded for convenience */
   179     void saveStateChangingPart(
   180 		LinkableMapObj *undoSelection, 
   181 		LinkableMapObj* redoSelection, 
   182 		const QString &redoCommand, 
   183 		const QString &comment);
   184 	/*! Overloaded for convenience */
   185     void saveStateRemovingPart(
   186 		LinkableMapObj *redoSelection, 
   187 		const QString &comment);
   188 	/*! Overloaded for convenience */
   189     void saveState(
   190 		LinkableMapObj *undoSelection, 
   191 		const QString &undoCommand, 
   192 		LinkableMapObj *redoSelection, 
   193 		const QString &redoCommand, 
   194 		const QString &comment); 
   195 	/*! Overloaded for convenience */
   196     void saveState(
   197 		const QString &undoSelection, 
   198 		const QString &undoCommand, 
   199 		const QString &redoSelection, 
   200 		const QString &redoCommand, 
   201 		const QString &comment) ;
   202     void saveState(
   203 		const QString &undoCommand, 
   204 		const QString &redoCommand, 
   205 		const QString &comment) ;
   206 
   207 
   208 ////////////////////////////////////////////
   209 // unsorted so far
   210 ////////////////////////////////////////////
   211 public:
   212 	void setScene(QGraphicsScene *s);
   213 	QGraphicsScene *getScene();
   214 
   215     LinkableMapObj* findMapObj(QPointF,LinkableMapObj*);	// find MapObj 
   216     LinkableMapObj* findObjBySelect (const QString &s);		// find MapObj by select string
   217     LinkableMapObj* findID (const QString &s);				// find MapObj by previously set ID
   218 
   219 	QString saveToDir (const QString&,const QString&,int, const QPointF&);// Save data recursivly to tempdir
   220 
   221 
   222 ////////////////////////////////////////////
   223 // Interface 
   224 ////////////////////////////////////////////
   225 public:
   226 	void setVersion(const  QString &);
   227 	void setAuthor  (const QString &);
   228 	QString getAuthor ();
   229 	void setComment (const QString &);
   230 	QString getComment ();
   231 	QString getDate();
   232 
   233 public:	
   234 	void setHeading(const QString &);		//!< Set heading of branch	
   235 //	QString getHeading (bool &ok,QPoint &p); //!< Get heading, ok if selection is branch
   236 
   237 private:
   238 	BranchObj* itFind;			// next object in find process
   239 	bool EOFind;				// true, if search failed
   240 public:
   241     BranchObj* findText(QString,bool);		// Find object
   242     void findReset();						// Reset Search
   243 
   244 	void setURL(const QString &url);
   245 	QString getURL();						// returns URL of selection or ""
   246 	QStringList getURLs();					// returns URLs of subtree
   247 
   248 	void linkFloatImageTo(const QString &);
   249 
   250 	void setFrameType(const FrameObj::FrameType &);
   251 	void setFrameType(const QString &);
   252 	void setFramePenColor (const QColor &);
   253 	void setFrameBrushColor (const QColor &);
   254 	void setFramePadding (const int &);
   255 	void setFrameBorderWidth (const int &);
   256 	void setIncludeImagesVer(bool);
   257 	void setIncludeImagesHor(bool);
   258 	void setHideLinkUnselected (bool);
   259 
   260 	/*! Should object be hidden in exports (clouded)? */
   261 	void setHideExport(bool);			
   262 
   263 	/*! Should object be hidden in exports (clouded)? */
   264 	void toggleHideExport();		
   265 
   266     void copy();						//!< Copy to clipboard
   267 private:	
   268     void pasteNoSave(const int &n);		//!< paste clipboard to branch
   269 public:	
   270     void paste();		//!< Paste clipboard to branch and backup
   271     void cut();			//!< Cut to clipboard (and copy)
   272 
   273     void moveBranchUp();	//!< Move branch up
   274     void moveBranchDown();	//!< Move branch down
   275 	void sortChildren();	//!< Sort children lexically
   276 
   277 	// The create methods are used to quickly parse a XML file
   278 	void createMapCenter();			//!< Create and select MapCenter
   279 	void createBranch();			//!< Create and select Branch
   280 	TreeItem* createImage();		//!< Create and select image
   281 
   282 	/*! \brief Add new mapcenter
   283 
   284 	    Disclaimer: Still experimental, not fully supported yet.
   285 	*/	
   286 	MapCenterObj* addMapCenter();
   287 private:	
   288 	MapCenterObj* addMapCenter(QPointF absPos);
   289 public:	
   290 	MapCenterObj* removeMapCenter(MapCenterObj *mco);
   291 
   292 	/*! \brief Add new branch
   293 
   294 		Depending on num the new branch is created
   295 
   296 		-3 above selection as child of selections parent
   297 		-2 as child of selection
   298 		-1 below selection as child of selections parent
   299 		0..n	insert at a specific position in selections parent
   300 		(needed for free relinking)
   301 	*/	
   302 	MapCenterObj* getLastMapCenter();		//!< get last added MapCenter, used for context menu
   303 
   304 private:	
   305     BranchObj* addNewBranchInt(int);		// pos allows to add above/below selection
   306 public:	
   307 	/*! \Add new branch
   308 		
   309 		Depending on num the new branch is created
   310 		-1 above selection
   311 		 0 as child of selection
   312 		 1 below selection
   313 	*/
   314     BranchObj* addNewBranch(int pos);		
   315     BranchObj* addNewBranchBefore();		//!< Insert branch between selection and its parent
   316     void deleteSelection();					//!< Delete selection
   317 	void deleteKeepChildren();				//!< remove branch, but keep children
   318 	void deleteChildren();					//!< keep branch, but remove children
   319 
   320 private:	
   321 	bool scrollBranch(BranchObj*);
   322 	bool unscrollBranch(BranchObj*);
   323 public:	
   324     void toggleScroll();
   325     void unscrollChildren();
   326 
   327     void addFloatImage(const QPixmap &img);
   328 
   329     void colorBranch(QColor);
   330     void colorSubtree(QColor);
   331 	QColor getCurrentHeadingColor();
   332 
   333 
   334 	void editURL();							// edit URL
   335 	void editLocalURL();					// edit URL to local file
   336 	void editHeading2URL();					// copy heading to URL
   337 	void editBugzilla2URL();				// create URL to Bugzilla
   338 	void editFATE2URL();					// create URL to FATE
   339 	void editVymLink();						// edit link to another map
   340 	void setVymLink (const QString &);	// Set vymLink for selection
   341 	void deleteVymLink();					// delete link to another map
   342 	QString getVymLink();					// return path to map
   343 	QStringList getVymLinks();				// return paths in subtree
   344 	void followXLink (int);
   345 	void editXLink (int);
   346 
   347 
   348 
   349 
   350 ////////////////////////////////////////////
   351 // Scripting
   352 ////////////////////////////////////////////
   353 public:	
   354 
   355 	/* \brief Process one command and its parameters */
   356     void parseAtom (const QString &atom);	
   357 
   358 	/* \brief Runs the script */
   359 	void runScript (QString script);
   360 
   361 private:
   362 	Parser parser;
   363 
   364 ////////////////////////////////////////////
   365 // Exports
   366 ////////////////////////////////////////////
   367 private:
   368 	HideTmpMode hidemode;	// true while exporting to hide some stuff
   369 
   370 public:
   371 	/*! Set or unset temporary hiding of objects during export  */
   372 	void setExportMode (bool);
   373 
   374 	/*! Save as image */
   375     void exportImage (QString fname="",bool askForName=true,QString format="PNG");
   376 
   377 
   378 	/*! Export as XTML to directory */
   379     void exportXML(QString dir="", bool askForName=true);
   380 
   381 	/*! Export as ASCII text to file */
   382 	void exportASCII (QString fname="",bool askForName=true);  
   383 
   384 	/*! Export as XHTML to directory */
   385     void exportXHTML(const QString& dir="", bool askForName=true);	
   386 
   387     /*! Export as OpenOfficeOrg presentation */
   388     void exportOOPresentation(const QString &,const QString &);	
   389 
   390 
   391 ////////////////////////////////////////////
   392 // View related
   393 ////////////////////////////////////////////
   394 public:
   395 	void registerEditor (QWidget *);
   396 	void unregisterEditor (QWidget *);
   397 
   398 private: 
   399 	QPointF contextPos;					//!< local position during context menu
   400 public:
   401 	void setContextPos (QPointF);		//!< local position during context menu
   402 	void unsetContextPos ();			//!< forget local position after context menu
   403 
   404 	void updateNoteFlag();				//!< Signal origination in TextEditor
   405     void updateRelPositions();
   406 
   407 	QRectF getTotalBBox();
   408 	void reposition();					//!< Call reposition for all MCOs
   409 	void setHideTmpMode (HideTmpMode mode);	
   410 
   411 	QPolygonF shape(BranchObj *bo);		//!< Returns arbitrary shape of subtree
   412 	void moveAway (LinkableMapObj *lmo);//!< Autolayout: Move all out of the way
   413 
   414 	//void ensureSelectionVisible();		//!< Show selection in all views
   415 
   416 private:
   417 	MapEditor *mapEditor;
   418 
   419 	QColor defLinkColor;		// default color for links
   420 	QColor defXLinkColor;		// default color for xlinks
   421 	int defXLinkWidth;			// default width for xlinks
   422 	LinkableMapObj::ColorHint linkcolorhint;// use heading color or own color
   423 	LinkableMapObj::Style linkstyle;		// default style for links
   424 
   425 private:
   426     QPixmap getPixmap();
   427 
   428 public:
   429 	void setMapLinkStyle (const QString &);	// Set style of link
   430 	LinkableMapObj::Style getMapLinkStyle ();	// requested in LMO
   431 	void setMapDefLinkColor(QColor);		// default color of links
   432 	void setMapLinkColorHintInt();			// color of links
   433 	void setMapLinkColorHint(LinkableMapObj::ColorHint);// color of links
   434 	void toggleMapLinkColorHint();			// after changing linkStyles
   435     void selectMapBackgroundImage();
   436     void setMapBackgroundImage(const QString &);
   437     void selectMapBackgroundColor();
   438     void setMapBackgroundColor(QColor);
   439     QColor getMapBackgroundColor();
   440 
   441 
   442 	LinkableMapObj::ColorHint getMapLinkColorHint();
   443 	QColor getMapDefLinkColor();
   444 	void setMapDefXLinkColor(QColor);
   445 	QColor getMapDefXLinkColor();
   446 	void setMapDefXLinkWidth (int);
   447 	int getMapDefXLinkWidth();
   448 
   449 	/*!  Move absolutly to (x,y).  */	
   450     void move    (const double &x, const double &y);
   451 
   452 	/*!  Move relativly to (x,y).  */	
   453     void moveRel (const double &x, const double &y);
   454 
   455 ////////////////////////////////////////////
   456 // Animation  **experimental**
   457 ////////////////////////////////////////////
   458 private:	
   459 	QTimer *animationTimer;
   460 	bool animationUse;
   461 	uint animationTicks;
   462 	uint animationInterval;
   463 	int timerId;				// animation timer
   464 	QList <MapObj*> animObjList;// list with animated objects
   465 
   466 private slots:
   467 	void animate();						//!< Called by timer to animate stuff
   468 public:
   469 	void startAnimation(BranchObj *bo, const QPointF &start, const QPointF &dest);
   470 	void stopAnimation(MapObj *mo);
   471 
   472 ////////////////////////////////////////////
   473 // Network related 
   474 ////////////////////////////////////////////
   475 public:
   476     /*! \brief Networking states
   477 		
   478 		In Network modus we want to switch of saveState, autosave, ...
   479 	*/
   480 	enum NetState {
   481 		Offline,			//!< Offline
   482 		Client,				//!< I am the client and connected to server
   483 		Server				//!< I am the server
   484 	};
   485 
   486 private:
   487 	// Network connections **Experimental**
   488 	NetState netstate;			// offline, client, server
   489 	QTcpServer *tcpServer;		// Act as server in conference mode (experimental)
   490 	QList <QTcpSocket*> clientList;		// List of connected clients
   491 	quint16 sendCounter;		// Increased with every sent command
   492 
   493 	QTcpSocket	*clientSocket;	// socket of this client
   494 	QString server;				// server address of this client
   495 	int port;					// server port of this client
   496 
   497 
   498 
   499 protected:
   500 	void sendSelection();
   501 
   502 public:
   503 	void newServer();
   504 	void connectToServer();
   505 
   506 private slots:	
   507 	void newClient();
   508 	void sendData(const QString &s);
   509 	void readData();
   510 	void displayNetworkError (QAbstractSocket::SocketError);
   511 
   512 private:	
   513 	void displayClientError(QAbstractSocket::SocketError socketError);
   514 
   515 
   516 ////////////////////////////////////////////
   517 // Selection related 
   518 ////////////////////////////////////////////
   519 private:
   520 	Selection selection;
   521 	QString latestSelectionString;	// select string of latest added object
   522 
   523 signals:
   524 	void selectionChanged(const QItemSelection &, const QItemSelection &);
   525 
   526 public:
   527 	void setSelectionModel(QItemSelectionModel *);		// Set common selectionModel
   528 	QItemSelectionModel* getSelectionModel();
   529 
   530 	void setSelectionBlocked(bool);
   531 	bool isSelectionBlocked();
   532 
   533 	bool select ();							// select by using common QItemSlectionModel
   534 	bool select (const QString &);			// Select by string
   535 	bool select (LinkableMapObj *lmo);		// Select by pointer to LMO
   536 	bool select (TreeItem *ti );			// Select by point to TreeItem
   537 	void unselect();
   538 	void reselect();
   539 
   540 	void ensureSelectionVisible();			//!< Show selection in all views
   541 
   542 	void selectInt(LinkableMapObj*);	
   543 
   544 private:	
   545 	void selectNextBranchInt();		// Increment number of branch
   546 	void selectPrevBranchInt();		// Decrement number of branch
   547 public:	
   548     void selectUpperBranch();
   549     void selectLowerBranch();
   550     void selectLeftBranch();
   551     void selectRightBranch();
   552     void selectFirstBranch();
   553     void selectLastBranch();
   554 	void selectLastSelectedBranch();
   555 	void selectParent();
   556 
   557 public:
   558 	TreeItem::Type selectionType();
   559 	LinkableMapObj* getSelectedLMO();
   560 	BranchObj* getSelectedBranch();
   561 	TreeItem* getSelectedBranchItem();
   562 	TreeItem* getSelectedItem();
   563 	QModelIndex getSelectedIndex();
   564 	FloatImageObj* getSelectedFloatImage();
   565 	QString getSelectString ();
   566 	QString getSelectString (LinkableMapObj *lmo);
   567 	
   568 	void updateSelection(const QItemSelection &oldsel);
   569 	void updateSelection();
   570 	void selectMapLinkColor();
   571     void selectMapSelectionColor();
   572 private:	
   573     void setSelectionColorInt(QColor);
   574 	QItemSelectionModel *selModel;
   575 
   576 public:	
   577     void setSelectionColor(QColor);
   578     QColor getSelectionColor();
   579 
   580 };
   581 
   582 #endif