19 #ifndef KDEV_DOC_PLUGIN_H 20 #define KDEV_DOC_PLUGIN_H 23 #include <tqvaluelist.h> 26 #include <tdelistbox.h> 27 #include <tdelistview.h> 31 #define CACHE_VERSION "3" 51 virtual void setURL(
const KURL &url) { m_url = url; }
52 virtual KURL url()
const {
return m_url; }
54 Type type()
const {
return m_type; }
56 void setType(
Type t) {
81 virtual void setOpen(
bool o);
84 virtual bool isProjectDocumentationItem()
const {
return m_isProjectDocumentationItem; }
85 virtual void setProjectDocumentationItem(
bool b) { m_isProjectDocumentationItem = b; }
87 virtual TQString cacheVersion()
const {
return ""; }
90 virtual void activate();
96 bool m_isProjectDocumentationItem;
107 const TQString &text,
const TQString &description);
110 void addURL(
const KURL &url) { m_url = url; }
111 KURL url()
const {
return m_url; }
112 TQString text()
const {
return m_text; }
113 TQString description()
const {
return m_description; }
119 TQString m_description;
125 typedef TQPair<TQString, KURL> URL;
126 typedef TQValueList<URL> List;
139 IndexBox(TQWidget *parent = 0,
const char *name = 0);
144 virtual void refill();
145 virtual void setDirty(
bool dirty);
149 TQMap<TQString, TQValueList<IndexItemProto*> > items;
165 bool indexPossible,
bool fullTextSearchPossible);
167 virtual TQString title()
const {
return m_title; }
168 virtual void setTitle(
const TQString title) { setText(3, m_title = title); }
169 virtual TQString url()
const {
return m_url; }
170 virtual void setURL(
const TQString url) { setText(4, m_url = url); }
172 virtual bool isChanged()
const {
return m_title == m_origTitle; }
173 virtual TQString origTitle()
const {
return m_origTitle; }
175 virtual void paintCell(TQPainter *p,
const TQColorGroup &cg,
int column,
int width,
int align);
176 virtual int width(
const TQFontMetrics &fm,
const TQListView *lv,
int c)
const;
178 bool contents()
const {
return m_contents; }
179 void setContents(
bool contents) { m_contents = contents; }
180 bool index()
const {
return m_index; }
181 void setIndex(
bool index) { m_index = index; }
182 bool fullTextSearch()
const {
return m_fullTextSearch; }
183 void setFullTextSearch(
bool fullTextSearch) { m_fullTextSearch = fullTextSearch; }
185 bool indexPossible()
const {
return m_indexPossible; }
186 bool fullTextSearchPossible()
const {
return m_fullTextSearchPossible; }
193 TQString m_origTitle;
197 bool m_fullTextSearch;
199 bool m_indexPossible;
200 bool m_fullTextSearchPossible;
225 ProjectDocumentation=8 ,
226 ProjectUserManual=16 };
240 virtual TQString pluginName()
const = 0;
244 virtual DocumentationCatalogItem *createCatalog(TDEListView *contents, TDEListViewItem *after,
const TQString &title,
const TQString &url) = 0;
249 virtual void init(TDEListView *contents);
256 virtual void reinit(TDEListView *contents,
IndexBox *index, TQStringList restrictions);
260 virtual void autoSetup();
262 virtual void autoSetupPlugin() = 0;
267 virtual bool catalogEnabled(
const TQString &name)
const;
269 virtual void setCatalogEnabled(
const TQString &name,
bool e);
296 virtual TQStringList fullTextSearchLocations() = 0;
299 virtual void loadCatalogConfiguration(TDEListView *configurationView);
303 virtual void saveCatalogConfiguration(TDEListView *configurationView);
305 virtual void addCatalogConfiguration(TDEListView *configurationView,
306 const TQString &title,
const TQString &url);
309 const TQString &title,
const TQString &url);
311 virtual void deleteCatalogConfiguration(
const ConfigurationItem *
const configurationItem);
314 virtual TQPair<KFile::Mode, TQString> catalogLocatorProps() = 0;
316 virtual TQString catalogTitle(
const TQString &url) = 0;
319 virtual void clear();
345 virtual void createIndex(
IndexBox *index);
353 TQMap<DocumentationCatalogItem*, TQValueList<IndexItemProto*> >
indexes;
363 TDEListViewItem* findCatalogPosition(
const TQString &key,
const TDEListView *contents)
const;
400 virtual void init(TDEListView *contents,
IndexBox *index,
const TQString &url);
402 virtual void deinit();
404 TQString pluginName()
const;
405 TQString catalogURL()
const;
409 virtual void reinit();
413 TDEListViewItem* findCatalogPosition(
const TQString &key,
const TDEListView *contents)
const;
421 class KDirWatch *m_watch;
422 class TDEListView *m_contents;
Book - a document with nested documents.
void setDirtyIndex(bool dirty)
Sets dirty flag for all indices.
TQMap< TQString, DocumentationCatalogItem * > namedCatalogs
A map of names of loaded documentation catalogs.
Documentation index item.
TDEConfig * config
Configuration object used by a plugin.
Collection - a collection of catalogs, folder with catalogs.
Documentation catalog list item.
Capability
Capability of documentation plugin.
void setCapabilities(int caps)
Sets capabilities of documentation plugin.
Documentation configuration item.
virtual ProjectDocumentationPlugin * projectDocumentationPlugin(ProjectDocType)
Returns associated project documentation plugin.
TQValueList< DocumentationCatalogItem * > catalogs
A list of loaded documentation catalogs.
bool hasCapability(Capability cap) const
Checks if documentation plugin has given capability.
TQStringList deletedConfigurationItems
Stores items deleted from configuration.
TQMap< DocumentationCatalogItem *, TQValueList< IndexItemProto * > > indexes
A map of indices of loaded documentation catalogs.
Documentation index view.
ProjectDocType
Possible project documentation types.
Documentation Plugin Interface.
Type
Type of documentation which is represented by this item.
Project documentation plugin.
Catalog - a term which defines a document or a group of documents.