/***************************************************************************
koctave3doc.h - description
-------------------
begin : Thu Oct 24 19:35:22 IST 2002
copyright : (C) 2002 by Matti
email : hei00rhe@syd.kth.se
***************************************************************************/
/***************************************************************************
* *
* 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 KOCTAVE3DOC_H
#define KOCTAVE3DOC_H
#ifdef HAVE_CONFIG_H
#include
#endif
// include files for QT
#include
#include
#include
// include files for KDE
#include
// forward declaration of the Koctave3 classes
class Koctave3View;
/** Koctave3Doc provides a document object for a document-view model.
*
* The Koctave3Doc class provides a document object that can be used in conjunction with the classes Koctave3App and Koctave3View
* to create a document-view model for standard KDE applications based on KApplication and KMainWindow. Thereby, the document object
* is created by the Koctave3App instance and contains the document structure with the according methods for manipulation of the document
* data by Koctave3View objects. Also, Koctave3Doc contains the methods for serialization of the document data from and to files.
*
* @author Source Framework Automatically Generated by KDevelop, (c) The KDevelop Team.
* @version KDevelop version 1.2 code generation
*/
class Koctave3Doc : public QObject
{
Q_OBJECT
public:
/** Constructor for the fileclass of the application */
Koctave3Doc(QWidget *parent, const char *name=0);
/** Destructor for the fileclass of the application */
~Koctave3Doc();
/** adds a view to the document which represents the document contents. Usually this is your main view. */
void addView(Koctave3View *view);
/** removes a view from the list of currently connected views */
void removeView(Koctave3View *view);
/** sets the modified flag for the document after a modifying action on the view connected to the document.*/
void setModified(bool _m=true){ modified=_m; };
/** returns if the document is modified or not. Use this to determine if your document needs saving by the user on closing.*/
bool isModified(){ return modified; };
/** "save modified" - asks the user for saving if the document is modified */
bool saveModified();
/** deletes the document's contents */
void deleteContents();
/** initializes the document generally */
bool newDocument();
/** closes the acutal document */
void closeDocument();
/** loads the document by filename and format and emits the updateViews() signal */
bool openDocument(const KURL& url, const char *format=0);
/** saves the document under filename and format.*/
bool saveDocument(const KURL& url, const char *format=0);
/** returns the KURL of the document */
const KURL& URL() const;
/** sets the URL of the document */
void setURL(const KURL& url);
public slots:
/** calls repaint() on all views connected to the document object and is called by the view by which the document has been changed.
* As this view normally repaints itself, it is excluded from the paintEvent.
*/
void slotUpdateAllViews(Koctave3View *sender);
public:
/** the list of the views currently connected to the document */
static QList *pViewList;
private:
/** the modified flag of the current document */
bool modified;
KURL doc_url;
};
#endif // KOCTAVE3DOC_H
| Generated by: matti on localhost on Thu Oct 24 19:36:31 2002, using kdoc 2.0a54. |