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