vymmodel.h
author insilmaril
Fri, 06 Mar 2009 15:02:58 +0000
changeset 741 1b4d1ea6ea8c
parent 740 6dc0a20031f7
child 742 54d44ecd6097
permissions -rw-r--r--
Iteration over map works now (again)
     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 	TreeItem* findCurrent;		// next object in find process
   239 	TreeItem* findPrevious;		// next object in find process
   240 	bool EOFind;				// true, if search failed
   241 public:
   242     BranchObj* findText(QString,bool);		// Find object
   243     void findReset();						// Reset Search
   244 
   245 	void setURL(const QString &url);
   246 	QString getURL();						// returns URL of selection or ""
   247 	QStringList getURLs();					// returns URLs of subtree
   248 
   249 	void linkFloatImageTo(const QString &);
   250 
   251 	void setFrameType(const FrameObj::FrameType &);
   252 	void setFrameType(const QString &);
   253 	void setFramePenColor (const QColor &);
   254 	void setFrameBrushColor (const QColor &);
   255 	void setFramePadding (const int &);
   256 	void setFrameBorderWidth (const int &);
   257 	void setIncludeImagesVer(bool);
   258 	void setIncludeImagesHor(bool);
   259 	void setHideLinkUnselected (bool);
   260 
   261 	/*! Should object be hidden in exports (clouded)? */
   262 	void setHideExport(bool);			
   263 
   264 	/*! Should object be hidden in exports (clouded)? */
   265 	void toggleHideExport();		
   266 
   267     void copy();						//!< Copy to clipboard
   268 private:	
   269     void pasteNoSave(const int &n);		//!< paste clipboard to branch
   270 public:	
   271     void paste();		//!< Paste clipboard to branch and backup
   272     void cut();			//!< Cut to clipboard (and copy)
   273 
   274     void moveBranchUp();	//!< Move branch up
   275     void moveBranchDown();	//!< Move branch down
   276 	void sortChildren();	//!< Sort children lexically
   277 
   278 	// The create methods are used to quickly parse a XML file
   279 	void createMapCenter();			//!< Create and select MapCenter
   280 	void createBranch();			//!< Create and select Branch
   281 	TreeItem* createImage();		//!< Create and select image
   282 
   283 	/*! \brief Add new mapcenter
   284 
   285 	    Disclaimer: Still experimental, not fully supported yet.
   286 	*/	
   287 	MapCenterObj* addMapCenter();
   288 private:	
   289 	MapCenterObj* addMapCenter(QPointF absPos);
   290 public:	
   291 	MapCenterObj* removeMapCenter(MapCenterObj *mco);
   292 
   293 	/*! \brief Add new branch
   294 
   295 		Depending on num the new branch is created
   296 
   297 		-3 above selection as child of selections parent
   298 		-2 as child of selection
   299 		-1 below selection as child of selections parent
   300 		0..n	insert at a specific position in selections parent
   301 		(needed for free relinking)
   302 	*/	
   303 	MapCenterObj* getLastMapCenter();		//!< get last added MapCenter, used for context menu
   304 
   305 private:	
   306     BranchObj* addNewBranchInt(int);		// pos allows to add above/below selection
   307 public:	
   308 	/*! \Add new branch
   309 		
   310 		Depending on num the new branch is created
   311 		-1 above selection
   312 		 0 as child of selection
   313 		 1 below selection
   314 	*/
   315     BranchObj* addNewBranch(int pos);		
   316     BranchObj* addNewBranchBefore();		//!< Insert branch between selection and its parent
   317     void deleteSelection();					//!< Delete selection
   318 	void deleteKeepChildren();				//!< remove branch, but keep children
   319 	void deleteChildren();					//!< keep branch, but remove children
   320 
   321 private:	
   322 	bool scrollBranch(BranchObj*);
   323 	bool unscrollBranch(BranchObj*);
   324 public:	
   325     void toggleScroll();
   326     void unscrollChildren();
   327 
   328     void addFloatImage(const QPixmap &img);
   329 
   330     void colorBranch(QColor);
   331     void colorSubtree(QColor);
   332 	QColor getCurrentHeadingColor();
   333 
   334 
   335 	void editURL();							// edit URL
   336 	void editLocalURL();					// edit URL to local file
   337 	void editHeading2URL();					// copy heading to URL
   338 	void editBugzilla2URL();				// create URL to Bugzilla
   339 	void editFATE2URL();					// create URL to FATE
   340 	void editVymLink();						// edit link to another map
   341 	void setVymLink (const QString &);	// Set vymLink for selection
   342 	void deleteVymLink();					// delete link to another map
   343 	QString getVymLink();					// return path to map
   344 	QStringList getVymLinks();				// return paths in subtree
   345 	void followXLink (int);
   346 	void editXLink (int);
   347 
   348 
   349 
   350 
   351 ////////////////////////////////////////////
   352 // Scripting
   353 ////////////////////////////////////////////
   354 public:	
   355 
   356 	/* \brief Process one command and its parameters */
   357     void parseAtom (const QString &atom);	
   358 
   359 	/* \brief Runs the script */
   360 	void runScript (QString script);
   361 
   362 private:
   363 	Parser parser;
   364 
   365 ////////////////////////////////////////////
   366 // Exports
   367 ////////////////////////////////////////////
   368 private:
   369 	HideTmpMode hidemode;	// true while exporting to hide some stuff
   370 
   371 public:
   372 	/*! Set or unset temporary hiding of objects during export  */
   373 	void setExportMode (bool);
   374 
   375 	/*! Save as image */
   376     void exportImage (QString fname="",bool askForName=true,QString format="PNG");
   377 
   378 
   379 	/*! Export as XTML to directory */
   380     void exportXML(QString dir="", bool askForName=true);
   381 
   382 	/*! Export as ASCII text to file */
   383 	void exportASCII (QString fname="",bool askForName=true);  
   384 
   385 	/*! Export as XHTML to directory */
   386     void exportXHTML(const QString& dir="", bool askForName=true);	
   387 
   388     /*! Export as OpenOfficeOrg presentation */
   389     void exportOOPresentation(const QString &,const QString &);	
   390 
   391 
   392 ////////////////////////////////////////////
   393 // View related
   394 ////////////////////////////////////////////
   395 public:
   396 	void registerEditor (QWidget *);
   397 	void unregisterEditor (QWidget *);
   398 
   399 private: 
   400 	QPointF contextPos;					//!< local position during context menu
   401 public:
   402 	void setContextPos (QPointF);		//!< local position during context menu
   403 	void unsetContextPos ();			//!< forget local position after context menu
   404 
   405 	void updateNoteFlag();				//!< Signal origination in TextEditor
   406     void updateRelPositions();
   407 
   408 	QRectF getTotalBBox();
   409 	void reposition();					//!< Call reposition for all MCOs
   410 	void setHideTmpMode (HideTmpMode mode);	
   411 
   412 	QPolygonF shape(BranchObj *bo);		//!< Returns arbitrary shape of subtree
   413 	void moveAway (LinkableMapObj *lmo);//!< Autolayout: Move all out of the way
   414 
   415 	//void ensureSelectionVisible();		//!< Show selection in all views
   416 
   417 private:
   418 	MapEditor *mapEditor;
   419 
   420 	QColor defLinkColor;		// default color for links
   421 	QColor defXLinkColor;		// default color for xlinks
   422 	int defXLinkWidth;			// default width for xlinks
   423 	LinkableMapObj::ColorHint linkcolorhint;// use heading color or own color
   424 	LinkableMapObj::Style linkstyle;		// default style for links
   425 
   426 private:
   427     QPixmap getPixmap();
   428 
   429 public:
   430 	void setMapLinkStyle (const QString &);	// Set style of link
   431 	LinkableMapObj::Style getMapLinkStyle ();	// requested in LMO
   432 	void setMapDefLinkColor(QColor);		// default color of links
   433 	void setMapLinkColorHintInt();			// color of links
   434 	void setMapLinkColorHint(LinkableMapObj::ColorHint);// color of links
   435 	void toggleMapLinkColorHint();			// after changing linkStyles
   436     void selectMapBackgroundImage();
   437     void setMapBackgroundImage(const QString &);
   438     void selectMapBackgroundColor();
   439     void setMapBackgroundColor(QColor);
   440     QColor getMapBackgroundColor();
   441 
   442 
   443 	LinkableMapObj::ColorHint getMapLinkColorHint();
   444 	QColor getMapDefLinkColor();
   445 	void setMapDefXLinkColor(QColor);
   446 	QColor getMapDefXLinkColor();
   447 	void setMapDefXLinkWidth (int);
   448 	int getMapDefXLinkWidth();
   449 
   450 	/*!  Move absolutly to (x,y).  */	
   451     void move    (const double &x, const double &y);
   452 
   453 	/*!  Move relativly to (x,y).  */	
   454     void moveRel (const double &x, const double &y);
   455 
   456 ////////////////////////////////////////////
   457 // Animation  **experimental**
   458 ////////////////////////////////////////////
   459 private:	
   460 	QTimer *animationTimer;
   461 	bool animationUse;
   462 	uint animationTicks;
   463 	uint animationInterval;
   464 	int timerId;				// animation timer
   465 	QList <MapObj*> animObjList;// list with animated objects
   466 
   467 private slots:
   468 	void animate();						//!< Called by timer to animate stuff
   469 public:
   470 	void startAnimation(BranchObj *bo, const QPointF &start, const QPointF &dest);
   471 	void stopAnimation(MapObj *mo);
   472 
   473 ////////////////////////////////////////////
   474 // Network related 
   475 ////////////////////////////////////////////
   476 public:
   477     /*! \brief Networking states
   478 		
   479 		In Network modus we want to switch of saveState, autosave, ...
   480 	*/
   481 	enum NetState {
   482 		Offline,			//!< Offline
   483 		Client,				//!< I am the client and connected to server
   484 		Server				//!< I am the server
   485 	};
   486 
   487 private:
   488 	// Network connections **Experimental**
   489 	NetState netstate;			// offline, client, server
   490 	QTcpServer *tcpServer;		// Act as server in conference mode (experimental)
   491 	QList <QTcpSocket*> clientList;		// List of connected clients
   492 	quint16 sendCounter;		// Increased with every sent command
   493 
   494 	QTcpSocket	*clientSocket;	// socket of this client
   495 	QString server;				// server address of this client
   496 	int port;					// server port of this client
   497 
   498 
   499 
   500 protected:
   501 	void sendSelection();
   502 
   503 public:
   504 	void newServer();
   505 	void connectToServer();
   506 
   507 private slots:	
   508 	void newClient();
   509 	void sendData(const QString &s);
   510 	void readData();
   511 	void displayNetworkError (QAbstractSocket::SocketError);
   512 
   513 private:	
   514 	void displayClientError(QAbstractSocket::SocketError socketError);
   515 
   516 
   517 ////////////////////////////////////////////
   518 // Selection related 
   519 ////////////////////////////////////////////
   520 private:
   521 	Selection selection;
   522 	QString latestSelectionString;	// select string of latest added object
   523 
   524 signals:
   525 	void selectionChanged(const QItemSelection &, const QItemSelection &);
   526 
   527 public:
   528 	void setSelectionModel(QItemSelectionModel *);		// Set common selectionModel
   529 	QItemSelectionModel* getSelectionModel();
   530 
   531 	void setSelectionBlocked(bool);
   532 	bool isSelectionBlocked();
   533 
   534 	bool select ();							// select by using common QItemSlectionModel
   535 	bool select (const QString &);			// Select by string
   536 	bool select (LinkableMapObj *lmo);		// Select by pointer to LMO
   537 	bool select (TreeItem *ti );			// Select by point to TreeItem
   538 	void unselect();
   539 	void reselect();
   540 
   541 	void ensureSelectionVisible();			//!< Show selection in all views
   542 
   543 	void selectInt(LinkableMapObj*);	
   544 
   545 private:	
   546 	void selectNextBranchInt();		// Increment number of branch
   547 	void selectPrevBranchInt();		// Decrement number of branch
   548 public:	
   549     void selectUpperBranch();
   550     void selectLowerBranch();
   551     void selectLeftBranch();
   552     void selectRightBranch();
   553     void selectFirstBranch();
   554     void selectLastBranch();
   555 	void selectLastSelectedBranch();
   556 	void selectParent();
   557 
   558 public:
   559 	TreeItem::Type selectionType();
   560 	LinkableMapObj* getSelectedLMO();
   561 	BranchObj* getSelectedBranch();
   562 	TreeItem* getSelectedBranchItem();
   563 	TreeItem* getSelectedItem();
   564 	QModelIndex getSelectedIndex();
   565 	FloatImageObj* getSelectedFloatImage();
   566 	QString getSelectString ();
   567 	QString getSelectString (LinkableMapObj *lmo);
   568 	
   569 	void updateSelection(const QItemSelection &oldsel);
   570 	void updateSelection();
   571 	void selectMapLinkColor();
   572     void selectMapSelectionColor();
   573 private:	
   574     void setSelectionColorInt(QColor);
   575 	QItemSelectionModel *selModel;
   576 
   577 public:	
   578     void setSelectionColor(QColor);
   579     QColor getSelectionColor();
   580 
   581 };
   582 
   583 #endif