summaryrefslogtreecommitdiffstats
path: root/libkdeedu/kdeeduui/kdeeduglossary.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce599e4f9f94b4eb00c1b5edb85bce5431ab3df2 (patch)
treed3bb9f5d25a2dc09ca81adecf39621d871534297 /libkdeedu/kdeeduui/kdeeduglossary.h
downloadtdeedu-ce599e4f9f94b4eb00c1b5edb85bce5431ab3df2.tar.gz
tdeedu-ce599e4f9f94b4eb00c1b5edb85bce5431ab3df2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeedu@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'libkdeedu/kdeeduui/kdeeduglossary.h')
-rw-r--r--libkdeedu/kdeeduui/kdeeduglossary.h292
1 files changed, 292 insertions, 0 deletions
diff --git a/libkdeedu/kdeeduui/kdeeduglossary.h b/libkdeedu/kdeeduui/kdeeduglossary.h
new file mode 100644
index 00000000..418967f6
--- /dev/null
+++ b/libkdeedu/kdeeduui/kdeeduglossary.h
@@ -0,0 +1,292 @@
+#ifndef KDEEDUGLOSSARY_H
+#define KDEEDUGLOSSARY_H
+/***************************************************************************
+
+ copyright : (C) 2005 by Carsten Niehaus
+ email : cniehaus@kde.org
+ ***************************************************************************/
+
+/***************************************************************************
+ * *
+ * 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. *
+ * *
+ ***************************************************************************/
+
+
+#include <khtml_part.h>
+#include <kdialogbase.h>
+
+class QChar;
+class QDomDocument;
+class QListViewItem;
+class KListView;
+class KListViewSearchLine;
+class KActionCollection;
+class GlossaryItem;
+
+/**
+ * @class Glossary
+ * @author Carsten Niehaus
+ *
+ * This class stores all items to be displayed. It also
+ * has access-methods to the items
+ */
+class Glossary
+{
+ public:
+ Glossary();
+ virtual ~Glossary();
+
+ /**
+ * add the item @p item to the glossary
+ */
+ void addItem( GlossaryItem* item ){
+ m_itemlist.append( item );
+ }
+
+ QValueList<GlossaryItem*> itemlist()const{
+ return m_itemlist;
+ }
+
+ /**
+ * clear the Glossary
+ */
+ void clear(){
+ m_itemlist.clear();
+ }
+
+ /**
+ * does this glossary have items?
+ */
+ bool isEmpty() const;
+
+ /**
+ * Every glossary can have a name. It will be
+ * set to @p name
+ */
+ void setName( const QString& name ){
+ m_name = name;
+ }
+
+ /**
+ * @returns the name of the glossary
+ */
+ QString name()const{
+ return m_name;
+ }
+
+ /**
+ * sets the internal list of items to @p list
+ */
+ void setItemlist( QValueList<GlossaryItem*> list ){
+ m_itemlist = list;
+ }
+
+ /**
+ * Read a glossary from an XML file.
+ *
+ * @param url The path of the file to load
+ * @param path The path of the pictures. Will be used as m_picturepath
+ *
+ * @return a pointer to the loaded glossary. Even in case of
+ * error, this won't return 0 but an empty Glossary.
+ */
+ static Glossary* readFromXML( const KURL& url, const QString& path = 0 );
+
+ /**
+ * Every glossaryitem can show pictures. [img src="foo.png]
+ * will look for the file foo.png in the path defined be
+ * @p path
+ */
+ void setPicturePath( const QString& path ){
+ m_picturepath = path;
+ }
+
+ QString picturePath()const{
+ return m_picturepath;
+ }
+
+ /**
+ * defines which picture to use as the background
+ * of the htmlview. The dialog
+ * will use the file specifiec by the @p filename
+ */
+ void setBackgroundPicture( const QString& filename ){
+ m_backgroundpicture = filename;
+ }
+
+ /**
+ * @return the picuture used as the background in
+ * this background
+ */
+ QString backgroundPicture()const{
+ return m_backgroundpicture;
+ }
+
+ private:
+ /**
+ * This methods parses the given xml-code. It will extract
+ * the information of the items and return them as a
+ * QValueList<GlossaryItem*>
+ */
+ virtual QValueList<GlossaryItem*> readItems( QDomDocument &itemDocument );
+
+ QString m_backgroundpicture;
+
+ /**
+ * replaces the [img]-pseudocode with valid html. The path where
+ * the pictures are stored will be used for pictures
+ */
+ void fixImagePath();
+
+ /**
+ * the path in which pictures of the glossary will be searched
+ */
+ QString m_picturepath;
+
+ /**
+ * Load the layout from an XML file.
+ *
+ * @param doc The QDomDocument which will contain the read XML
+ * contents.
+ * @param url The path of the file to load
+ *
+ * @return a bool indicating whether the loading of the XML was
+ * successfull or not
+ */
+ bool loadLayout( QDomDocument& doc, const KURL& url );
+
+ QValueList<GlossaryItem*> m_itemlist;
+
+ /**
+ * the name of the glossary
+ */
+ QString m_name;
+};
+
+/**
+ * @class GlossaryItem
+ * @author Carsten Niehaus
+ *
+ * A GlossaryItem stores the information of the content of
+ * the item and its name. Furthermore, every item can have
+ * a number of pictures or references associated to it.
+ * These are stored as QStringLists.
+ */
+class GlossaryItem
+{
+ public:
+ GlossaryItem(){}
+ ~GlossaryItem(){}
+
+ void setName( const QString& s ){
+ m_name = s;
+ }
+
+ void setDesc( const QString& s){
+ m_desc = s;
+ }
+
+ void setRef( const QStringList& s){
+ m_ref = s;
+ }
+
+ void setPictures( const QString& s ){
+ m_pic = s;
+ }
+
+ QString name() const {
+ return m_name;
+ }
+
+ QString desc() const {
+ return m_desc;
+ }
+
+ QStringList ref() const {
+ return m_ref;
+ }
+
+ QStringList pictures() const {
+ return m_pic;
+ }
+
+ /**
+ * @return the formated HTML code for current item.
+ **/
+ QString toHtml() const;
+
+ /**
+ * This method parses the references.
+ * @return the HTML code with the references as HTML links
+ */
+ QString parseReferences() const;
+
+ private:
+ QString m_name;
+ QString m_desc;
+ QStringList m_ref;
+ QStringList m_pic;
+};
+
+/**
+ * @class GlossaryDialog
+ * @author Pino Toscano
+ * @author Carsten Niehaus
+ */
+class GlossaryDialog : public KDialogBase
+{
+ Q_OBJECT
+
+ public:
+ GlossaryDialog( bool folded = true, QWidget *parent=0, const char *name=0);
+ ~GlossaryDialog();
+
+ void keyPressEvent(QKeyEvent*);
+
+ /**
+ * add a new glossary
+ *
+ * @param newgloss the new glossary to add
+ */
+ void addGlossary( Glossary* newgloss );
+
+ private:
+ QValueList<Glossary*> m_glossaries;
+
+ /**
+ * if true the items will be displayed folded
+ */
+ bool m_folded;
+
+ void updateTree();
+
+ KHTMLPart *m_htmlpart;
+ KListView *m_glosstree;
+ QString m_htmlbasestring;
+
+ KActionCollection* m_actionCollection;
+
+ QListViewItem* findTreeWithLetter( const QChar&, QListViewItem* );
+
+ KListViewSearchLine *m_search;
+
+ private slots:
+ void slotClicked( QListViewItem * );
+ /**
+ * The user clicked on a href. Emit the corresponding item
+ */
+ void displayItem( const KURL& url, const KParts::URLArgs& args );
+
+ protected slots:
+ virtual void slotClose();
+
+ signals:
+ void closed();
+};
+
+#endif // KDEEDUGLOSSARY_H
+