Backbone Member List

This is the complete list of members for Backbone, including all inherited members. - + + + @@ -59,12 +61,17 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); + + + + + @@ -83,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classBackbone.html b/doc/html/classBackbone.html index 2abc23f..fc85f9a 100644 --- a/doc/html/classBackbone.html +++ b/doc/html/classBackbone.html @@ -45,7 +45,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Backbone Class Reference

Inner part of dictionary - glues together GUI and plugins. +

/file backbone.cpp More...

#include <backbone.h>

@@ -55,7 +55,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

- + @@ -77,6 +77,18 @@ void + + + + + + + + + + + @@ -87,6 +99,12 @@ void + + + + -

activeSearches() const	Backbone
addBookmark(QList< Translation * > translations)	Backbone	`[inline, slot]`
addDictionary(CommonDictInterface *dict, bool active=1)	Backbone	`[slot]`
Backbone(QString pluginPath="", QString configPath="", bool dry=0, QObject *parent=0)	Backbone
Backbone(const Backbone &b) (defined in Backbone)	Backbone
bookmarksReady()	Backbone	`[signal]`
closeOk()	Backbone	`[signal]`
dictUpdated()	Backbone	`[slot]`
fetchBookmarks()	Backbone	`[inline, slot]`
getDictionaries()	Backbone
getPlugins()	Backbone
history()	Backbone
htmlTranslationReady()	Backbone	`[slot]`
quit()	Backbone	`[slot]`
ready()	Backbone	`[signal]`
removeAllBookmark()	Backbone	`[inline, slot]`
removeBookmark(QList< Translation * > translations)	Backbone	`[inline, slot]`
removeDictionary(CommonDictInterface *dict)	Backbone	`[slot]`
result()	Backbone
search(QString word)	Backbone	`[slot]`
searchCanceled()	Backbone	`[signal]`
searchHtml(QList< Translation * >)	Backbone	`[slot]`
searchLimit() const	Backbone
selectedDictionaries(QList< CommonDictInterface * >)	Backbone	`[slot]`
setSettings(Settings *settings)	Backbone	`[slot]`
settings()	Backbone	`[slot]`
stopSearching()	Backbone	`[slot]`
translationReady()	Backbone	`[slot]`
~Backbone() (defined in Backbone)	Backbone
Public Slots
void	stopSearching ()
	stops all current searches
	stops all current searches and emiting searchCanceled signal
void	search (QString word)
	search for a word translation
void	selectedDictionaries (QList< CommonDictInterface * >)
	saves plugins new state/configuration after each change
void	searchHtml (QList< Translation * >)
	Performs search for final translation (html/xml) form.
void	addBookmark (QList< Translation * > translations)
	add bookmarks to given translations (translation object is fetched and added to bookmarks data base (key and translation stored in db)
void	removeBookmark (QList< Translation * > translations)
	Remove bookmarks to given translatios.
+void	removeAllBookmark ()
	Remove all bookmarks.
void	fetchBookmarks ()
	Searching for list of bookmarks may take some time, so i moved it to new thread (to avoid gui blocking), futher its consistent with ordinary searching for list of word (.
void	setSettings (Settings *settings)
	Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks, search_dictionaries).
Settings *	settings ()
Signals
void	closeOk ()
void	htmlReady ()
	emitted when html result is ready to fetch
+void	searchCanceled ()
	throwed when searches are stopped
+void	bookmarksReady ()
	emmited when bookmark list is ready to fetch
Public Member Functions
	Backbone (QString pluginPath="", QString configPath="", bool dry=0, QObject *parent=0)
@@ -98,13 +116,23 @@ void	QMultiHash< QString, Translation * >	result ()
int	searchLimit () const
int	activeSearches () const
QStringList	htmls ()

Detailed Description

Inner part of dictionary - glues together GUI and plugins.

Backbone is responsible for managing plugins and dictionaries, starting new searches and threads, merging search results from multiple dictionaries.

Each plugin may live in multiple instances - each with its own dictionary, backbone must provide way to create them at start (with specific Settings) and distinguich each ditionary.

/file backbone.cpp

Backbone/core main header

See also:: Backbone

Author:: Bartosz Szatkowski <bulislaw@linux.com>

Inner part of dictionary - glues together GUI and plugins, also kind of GoF facade (for GUI) cover few classes

See also:: Bookmarks; +History

Backbone is responsible for managing plugins and dictionaries, starting new searches and threads, merging search results from multiple dictionaries.

Each plugin may live in multiple instances - each with its own dictionary, backbone must provide way to create them at start (with specific Settings) and distinguich each ditionary.

Backbone also manage bookmarks and history: providing interface to gui

Backbone is also responsible for saving and spawning session via configs file (stored in ~/.mdictionary) -> configs are kind of tricky because mDictionary is delivered with two simple dicts -> its necessary to separate default configs from user configs (updating/reinstaling app results in overwriten default config file), moreover config file there is general mdictionary configuration (aparto from dictionaries and plugin ones).

Other modules may set some internal backbone behaviour via

See also:: setSettings(): Settings object with option given: history_size - int, size of stored searches search_limit - int, how many different word may each dictionary returns search_dictionaries - true/false, whether search in dictionaries search_bookmarks - true/false, whether search in bookmarks

Constructor & Destructor Documentation

@@ -153,21 +181,29 @@ void +

- + - + + - +

int Backbone::activeSearches void Backbone::addBookmark ( QList< Translation * > translations ) const [inline, slot]

Returns:: number of active searches

+ +

add bookmarks to given translations (translation object is fetched and added to bookmarks data base (key and translation stored in db)

Parameters:

+ + +

translation

translation object to be stored in db

@@ -207,6 +243,26 @@ void +

+ + + + + + + + +

void Backbone::fetchBookmarks ( ) [inline, slot]

+ +

Searching for list of bookmarks may take some time, so i moved it to new thread (to avoid gui blocking), futher its consistent with ordinary searching for list of word (.

See also:: search)

+ +

@@ -299,6 +355,32 @@ void +

+ + + + + + + + + +

void Backbone::removeBookmark ( QList< Translation * > translations ) [inline, slot]

+ +

Remove bookmarks to given translatios.

Parameters:

+ + +

translation

remove bookmark to this translation

+ +

@@ -439,9 +521,55 @@ void +

+ + + + + + + + + +

void Backbone::setSettings ( Settings * settings ) [slot]

+ +

Sets settings for backbone: history_size, search_limit, searching backends (search_bookmarks, search_dictionaries).

Parameters:

+ + +

settings

settings object with opitons set

+ +

+ + + + + + + + +

Settings * Backbone::settings ( ) [slot]

Returns:: coresponding settings object with history_size, search_limit, searching backends (search_bookmarks, search_dictionaries)

+ +

The documentation for this class was generated from the following files:

backbone.h
backbone.cpp
moc_backbone.cpp
build-desktop/moc_backbone.cpp

@@ -458,7 +586,7 @@ void

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classBookmarkTranslation-members.html b/doc/html/classBookmarkTranslation-members.html new file mode 100644 index 0000000..d002b16 --- /dev/null +++ b/doc/html/classBookmarkTranslation-members.html @@ -0,0 +1,78 @@ + + + + + +mDictionary: Member List + + + + + + + + + +

BookmarkTranslation Member List

This is the complete list of members for BookmarkTranslation, including all inherited members. + + + + + + + + + + + +

_bookmark (defined in Translation)	Translation	`[protected]`
BookmarkTranslation(QString key, Bookmarks *bookmarks, QString dbName) (defined in BookmarkTranslation)	BookmarkTranslation	`[inline]`
dictionaryInfo() const	BookmarkTranslation	`[inline, virtual]`
isBookmark() const	Translation	`[inline]`
key() const	BookmarkTranslation	`[inline, virtual]`
operator==(Translation *translation) (defined in Translation)	Translation	`[inline]`
setBookmark(bool b)	Translation	`[inline]`
setDictionaryInfo(QString dictionaryInfo)	BookmarkTranslation	`[inline]`
setKey(QString key)	BookmarkTranslation	`[inline]`
toHtml() const	BookmarkTranslation	`[inline, virtual]`
Translation() (defined in Translation)	Translation	`[inline]`

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classBookmarkTranslation.html b/doc/html/classBookmarkTranslation.html new file mode 100644 index 0000000..9b2bbae --- /dev/null +++ b/doc/html/classBookmarkTranslation.html @@ -0,0 +1,190 @@ + + + + + +mDictionary: BookmarkTranslation Class Reference + + + + + + + + + +

BookmarkTranslation Class Reference

/file BookmarkTranslation.h +More...

+ +

#include <BookmarkTranslations.h>

+Inheritance diagram for BookmarkTranslation:

+ + + +

+ +

List of all members.

+ + + + + + + + + + +

Public Member Functions
+	BookmarkTranslation (QString key, Bookmarks *bookmarks, QString dbName)
QString	key () const
QString	dictionaryInfo () const
QString	toHtml () const
void	setKey (QString key)
	sets the word for which we want to find a translation
+void	setDictionaryInfo (QString dictionaryInfo)
	sets information about dictionary

Detailed Description

/file BookmarkTranslation.h

Bookmarks functionality needs its own translation object - becouse Translation object should use slighty different api of Bookmarks objects

Author:: Bartosz Szatkowski <bulislaw@linux.com>

Member Function Documentation

+ +

+ + + + + + + + +

QString BookmarkTranslation::dictionaryInfo ( ) const [inline, virtual]

Returns:: dictionary information (plugin name, languages, <logo> etc)\ to be displayed in translation table header

+ +

Implements Translation.

+ +

+ + + + + + + + +

QString BookmarkTranslation::key ( ) const [inline, virtual]

Returns:: word to be translated

+ +

Implements Translation.

+ +

+ + + + + + + + + +

void BookmarkTranslation::setKey ( QString key ) [inline]

+ +

sets the word for which we want to find a translation

Parameters:

+ + +

word

for which we want to find a translation

+ +

+ + + + + + + + +

QString BookmarkTranslation::toHtml ( ) const [inline, virtual]

Returns:: parsed raw format into html

+ +

Implements Translation.

+ +

The documentation for this class was generated from the following file:

BookmarkTranslations.h

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classBookmarkTranslation.png b/doc/html/classBookmarkTranslation.png new file mode 100644 index 0000000..0bb0bf5 Binary files /dev/null and b/doc/html/classBookmarkTranslation.png differ diff --git a/doc/html/classBookmarks-members.html b/doc/html/classBookmarks-members.html new file mode 100644 index 0000000..6584e06 --- /dev/null +++ b/doc/html/classBookmarks-members.html @@ -0,0 +1,75 @@ + + + + + +mDictionary: Member List + + + + + + + + + +

Bookmarks Member List

This is the complete list of members for Bookmarks, including all inherited members. + + + + + + + + +

add(Translation *translation)	Bookmarks
Bookmarks() (defined in Bookmarks)	Bookmarks
clear()	Bookmarks
inBookmarks(QString word)	Bookmarks
list()	Bookmarks
remove(Translation *translation)	Bookmarks
search(QString word, QString dbname)	Bookmarks
searchWordList(QString word)	Bookmarks

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classBookmarks.html b/doc/html/classBookmarks.html new file mode 100644 index 0000000..e91d36c --- /dev/null +++ b/doc/html/classBookmarks.html @@ -0,0 +1,255 @@ + + + + + +mDictionary: Bookmarks Class Reference + + + + + + + + + +

Bookmarks Class Reference

Bookmarks are way to store words that You think You will need to search for often. +More...

+ +

#include <Bookmarks.h>

+ +

List of all members.

+ + + + + + + + + + + + + + +

Public Member Functions
void	add (Translation *translation)
	Adds new word and translation to bookmarks.
void	remove (Translation *translation)
	Removes word and coresponding translation cache from bookmark list.
QList< Translation * >	list ()
QList< Translation * >	searchWordList (QString word)
	search in bookmarks for given word (wildcards may apply '*' and '?')
QStringList	search (QString word, QString dbname)
	Search for final translation of given word.
+void	clear ()
	clars bookmarks database
bool	inBookmarks (QString word)

Detailed Description

Bookmarks are way to store words that You think You will need to search for often.

When You add bookmark (by clickin on "star" in words list) You adds it to special list with cached translations from all available dictionaries so You can search for them quickly even when You delete coresponding dict.

Member Function Documentation

+ +

+ + + + + + + + + +

void Bookmarks::add ( Translation * translation )

+ +

Adds new word and translation to bookmarks.

Parameters:

+ + +

translation

new translation to be saved and cached as a bookmark

+ +

+ + + + + + + + + +

bool Bookmarks::inBookmarks ( QString word )

Returns:: true if given word is already in bookmarks

Parameters:

+ + +

word

to check

+ +

+ + + + + + + + +

QList< Translation * > Bookmarks::list ( )

Returns:: all bookmarks (word and translation as a translation object as a list

+ +

+ + + + + + + + + +

void Bookmarks::remove ( Translation * translation )

+ +

Removes word and coresponding translation cache from bookmark list.

Parameters:

+ + +

translation

translation to be removed

+ +

+ + + + + + + + + + + + + + + + + + +

QStringList Bookmarks::search	(	QString	word,
		QString	dbname
	)

+ +

Search for final translation of given word.

Returns:: word translation list in text format xml or html to be formated and displayed

Parameters:

+ + +

word

word to search for

+ +

+ + + + + + + + + +

QList< Translation * > Bookmarks::searchWordList ( QString word )

+ +

search in bookmarks for given word (wildcards may apply '*' and '?')

Parameters:

+ + +

word

to search for

Returns:: list of matching Translation objects

+ +

The documentation for this class was generated from the following files:

Bookmarks.h
Bookmarks.cpp

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classBookmarksWidget-members.html b/doc/html/classBookmarksWidget-members.html new file mode 100644 index 0000000..32afef1 --- /dev/null +++ b/doc/html/classBookmarksWidget-members.html @@ -0,0 +1,70 @@ + + + + + +mDictionary: Member List + + + + + + + + + +

BookmarksWidget Member List

This is the complete list of members for BookmarksWidget, including all inherited members. + + + +

BookmarksWidget(GUIInterface *parent=0) (defined in BookmarksWidget)	BookmarksWidget	`[explicit]`
removeAllBookmarks() (defined in BookmarksWidget)	BookmarksWidget	`[signal]`
showAllBookmarks() (defined in BookmarksWidget)	BookmarksWidget	`[signal]`

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classBookmarksWidget.html b/doc/html/classBookmarksWidget.html new file mode 100644 index 0000000..dfd3d07 --- /dev/null +++ b/doc/html/classBookmarksWidget.html @@ -0,0 +1,83 @@ + + + + + +mDictionary: BookmarksWidget Class Reference + + + + + + + + + +

BookmarksWidget Class Reference

List of all members.

+ + + + + + +

Signals
+void	showAllBookmarks ()
+void	removeAllBookmarks ()
Public Member Functions
+	BookmarksWidget (GUIInterface *parent=0)

The documentation for this class was generated from the following files:

BookmarksWidget.h
BookmarksWidget.cpp
moc_BookmarksWidget.cpp

+ +

+ All Classes Files Functions

+ + +

+ +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3

+ + diff --git a/doc/html/classCommonDictInterface-members.html b/doc/html/classCommonDictInterface-members.html index 024fdf3..ada353a 100644 --- a/doc/html/classCommonDictInterface-members.html +++ b/doc/html/classCommonDictInterface-members.html @@ -49,7 +49,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); dictDialog()=0CommonDictInterface [pure virtual] getNew(const Settings *) const =0CommonDictInterface [pure virtual] hash() const =0CommonDictInterface [pure virtual] - icon()=0CommonDictInterface [pure virtual] + icon()=0CommonDictInterface [pure virtual] infoNote() const =0CommonDictInterface [pure virtual] isAvailable() const =0CommonDictInterface [pure virtual] langFrom() const =0CommonDictInterface [pure virtual] @@ -78,7 +78,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classCommonDictInterface.html b/doc/html/classCommonDictInterface.html index 22c8d4d..f147776 100644 --- a/doc/html/classCommonDictInterface.html +++ b/doc/html/classCommonDictInterface.html @@ -112,8 +112,8 @@ virtual void virtual Settings * settings ()=0 returns current plugin settings
- -virtual QIcon icon ()=0 + +virtual QIcon * icon ()=0 returns plugin icon

Detailed Description

@@ -181,7 +181,10 @@ virtual QIcon

The documentation for this class was generated from the following files:

CommonDictInterface.h
moc_CommonDictInterface.cpp
base/moc_CommonDictInterface.cpp
base-build-desktop/moc_CommonDictInterface.cpp
plugins/xdxf/src/moc_CommonDictInterface.cpp
plugins/xdxf/tests/moc_CommonDictInterface.cpp

@@ -198,7 +201,7 @@ virtual QIcon

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classDictDialog-members.html b/doc/html/classDictDialog-members.html index 80a320e..3d1b13d 100644 --- a/doc/html/classDictDialog-members.html +++ b/doc/html/classDictDialog-members.html @@ -63,7 +63,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classDictDialog.html b/doc/html/classDictDialog.html index c95ff99..0d77c3f 100644 --- a/doc/html/classDictDialog.html +++ b/doc/html/classDictDialog.html @@ -147,7 +147,7 @@ Inheritance diagram for DictDialog:

MainWindow Member List

This is the complete list of members for MainWindow, including all inherited members. + @@ -64,6 +65,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); + + @@ -87,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classMainWindow.html b/doc/html/classMainWindow.html index 4cd933a..91ac918 100644 --- a/doc/html/classMainWindow.html +++ b/doc/html/classMainWindow.html @@ -90,6 +90,10 @@ void

+ + @@ -248,7 +252,7 @@ void + + + + +

addNewDictionary(CommonDictInterface *) GUIInterface [signal]

addToBookmarks(QList< Translation * >) (defined in GUIInterface) GUIInterface [signal]

addToHistory(QList< Translation * >) MainWindow [virtual, slot]

closeEvent(QCloseEvent *) MainWindow [protected]

exactSearch() MainWindow

setBusy() GUIInterface [signal]

setExactSearch(bool) MainWindow

setIdle() GUIInterface [signal]

setSettings(Settings *) (defined in MainWindow) MainWindow [virtual]

settings() (defined in MainWindow) MainWindow [virtual]

showHistory() MainWindow [virtual, slot]

showTranslation(QStringList) GUIInterface [signal]

showWordList(QHash< QString, QList< Translation * > >) GUIInterface [signal]

Indicates if GUI is in exact search mode.

void setExactSearch (bool)

Sets GUI exact search mode.

+Settings * settings ()

+void setSettings (Settings *)

Protected Member Functions

void closeEvent (QCloseEvent *)

Shows translation of next word in history.

It will work only if there is available next word in history. Translation of word is searched with searchExact() function

See also:: searchExact()

Implements GUIInterface.

@@ -271,7 +275,7 @@ void

Shows translation of previous word in history.

It will work only if there is available previous word in history. Translation of word is searched with searchExact() function

See also:: searchExact()

Implements GUIInterface.

@@ -381,7 +385,7 @@ void

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classMenuTabWidget-members.html b/doc/html/classMenuTabWidget-members.html index 01e2ef9..476593b 100644 --- a/doc/html/classMenuTabWidget-members.html +++ b/doc/html/classMenuTabWidget-members.html @@ -62,7 +62,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classMenuTabWidget.html b/doc/html/classMenuTabWidget.html index 4ec7e6b..5213352 100644 --- a/doc/html/classMenuTabWidget.html +++ b/doc/html/classMenuTabWidget.html @@ -103,7 +103,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classMenuWidget-members.html b/doc/html/classMenuWidget-members.html index 12d632a..635f8a8 100644 --- a/doc/html/classMenuWidget-members.html +++ b/doc/html/classMenuWidget-members.html @@ -47,6 +47,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

MenuWidget Member List

This is the complete list of members for MenuWidget, including all inherited members. + @@ -66,7 +67,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classMenuWidget.html b/doc/html/classMenuWidget.html index a976984..a988b87 100644 --- a/doc/html/classMenuWidget.html +++ b/doc/html/classMenuWidget.html @@ -52,6 +52,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

List of all members.

addSubMenu(QString title, QWidget *widget)	MenuWidget
createWidget(QWidget *parent) (defined in MenuWidget)	MenuWidget	`[protected]`
hideMenu() (defined in MenuWidget)	MenuWidget	`[slot]`
MenuWidget(QWidget *parent=0) (defined in MenuWidget)	MenuWidget	`[explicit]`
removeSubMenu(QString title)	MenuWidget
tabWidget (defined in MenuWidget)	MenuWidget	`[protected]`

+ + @@ -147,7 +150,7 @@ QWidget * + @@ -73,7 +74,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classSearchBarWidget.html b/doc/html/classSearchBarWidget.html index 4288a0a..4ca46e8 100644 --- a/doc/html/classSearchBarWidget.html +++ b/doc/html/classSearchBarWidget.html @@ -61,6 +61,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

+ + @@ -110,6 +112,27 @@ void - + @@ -193,6 +216,8 @@ void

Public Slots

+void hideMenu ()

Public Member Functions

MenuWidget (QWidget *parent=0)

createWidget -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classSearchBarWidget-members.html b/doc/html/classSearchBarWidget-members.html index f0f3039..9f2aa19 100644 --- a/doc/html/classSearchBarWidget-members.html +++ b/doc/html/classSearchBarWidget-members.html @@ -51,6 +51,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

refreshHistoryButtons() SearchBarWidget [signal]

search(QString word) SearchBarWidget [slot]

SearchBarWidget(QWidget *parent=0) (defined in SearchBarWidget) SearchBarWidget [explicit]

searchDelay(QString word) SearchBarWidget [slot]

searchForTranslations(QString) SearchBarWidget [signal]

setBusy() SearchBarWidget [slot]

setEnabled(bool) SearchBarWidget [slot]

Sets search bar in idle state.

void search (QString word)

Search for given word.

void searchDelay (QString word)

Start to search for given word after 500 ms.

void updateHistoryButtons (bool prev, bool next, bool list)

Updates state of history buttons.

+ + + + + + + + + +

void SearchBarWidget::searchDelay ( QString word ) [slot]

+ +

Start to search for given word after 500 ms.

Sets word as text in search word line edit, and wait 500 ms to start search. If in meanwhile this slot is called again it will stop previous timers.

+ +

@@ -118,7 +141,7 @@ void

void SearchBarWidget::searchForTranslations

(

QString

_t1

)

[signal]

SearchBarWidget.h

SearchBarWidget.cpp

moc_SearchBarWidget.cpp

build-desktop/moc_SearchBarWidget.cpp

@@ -209,7 +234,7 @@ void

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classSettings-members.html b/doc/html/classSettings-members.html index 0be4a1c..6226e5f 100644 --- a/doc/html/classSettings-members.html +++ b/doc/html/classSettings-members.html @@ -65,7 +65,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -

Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +

Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3

diff --git a/doc/html/classSettings.html b/doc/html/classSettings.html index 012ba00..8b4d73c 100644 --- a/doc/html/classSettings.html +++ b/doc/html/classSettings.html @@ -45,7 +45,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Settings Class Reference

Plugin specific configuration. +

Plugins or dictionaries may need to keep some of configuration between sessions, moreover Backbone or GUI may want store some additional info in plugin Settings. More...

#include <settings.h>

@@ -63,7 +63,8 @@ void

keys () const

Detailed Description

Plugin specific configuration.

Plugins or dictionaries may need to keep some of configuration between sessions, moreover Backbone or GUI may want store some additional info in plugin Settings.

Its important for plugin to store all information given it in Settings.

Member Function Documentation

@@ -108,7 +109,7 @@ QList< QString >

key -
Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +
Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3
diff --git a/doc/html/classSettingsWidget-members.html b/doc/html/classSettingsWidget-members.html new file mode 100644 index 0000000..ba51be1 --- /dev/null +++ b/doc/html/classSettingsWidget-members.html @@ -0,0 +1,70 @@ + + + + + +mDictionary: Member List + + + + + + + + +
+
+
+
Main Page
+
Classes
+
Files
+
+
+ + + +
+
+
+
+
+
+
Class List
+
Class Hierarchy
+
Class Members
+
+
+
+
+
SettingsWidget Member List
This is the complete list of members for SettingsWidget, including all inherited members. + + + +
hideEvent(QHideEvent *) (defined in SettingsWidget) SettingsWidget [protected]
SettingsWidget(GUIInterface *parent=0) (defined in SettingsWidget) SettingsWidget [explicit]
showEvent(QShowEvent *) (defined in SettingsWidget) SettingsWidget [protected]
+ +
+ All Classes Files Functions
+ + +
+ + +
+ +
Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3
+ + diff --git a/doc/html/classSettingsWidget.html b/doc/html/classSettingsWidget.html new file mode 100644 index 0000000..2a22757 --- /dev/null +++ b/doc/html/classSettingsWidget.html @@ -0,0 +1,82 @@ + + + + + +mDictionary: SettingsWidget Class Reference + + + + + + + + +
+
+
+
Main Page
+
Classes
+
Files
+
+
+ + + +
+
+
+
+
+
+
Class List
+
Class Hierarchy
+
Class Members
+
+
+
+
+
SettingsWidget Class Reference
+
List of all members.
+ + + + + + +
Public Member Functions
+ SettingsWidget (GUIInterface *parent=0)
Protected Member Functions
+void showEvent (QShowEvent *)
+void hideEvent (QHideEvent *)
+
The documentation for this class was generated from the following files:
+
SettingsWidget.h
+
SettingsWidget.cpp
+
+
+ +
+ All Classes Files Functions
+ + +
+ + +
+ +
Generated on Wed Aug 18 16:45:34 2010 for mDictionary by + + 1.6.3
+ + diff --git a/doc/html/classTranslation-members.html b/doc/html/classTranslation-members.html index 63415a5..25f89fc 100644 --- a/doc/html/classTranslation-members.html +++ b/doc/html/classTranslation-members.html @@ -45,10 +45,14 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Translation Member List
This is the complete list of members for Translation, including all inherited members. + + + +
_bookmark (defined in Translation) Translation [protected]

dictionaryInfo() const =0 Translation [pure virtual]
isBookmark() const Translation [inline]

key() const =0 Translation [pure virtual]

operator==(Translation *translation) (defined in Translation) Translation [inline]
setBookmark(bool b) Translation [inline]

toHtml() const =0 Translation [pure virtual]
Translation() (defined in Translation) Translation [inline]

-
Generated on Thu Aug 12 14:34:59 2010 for mDictionary by +
Generated on Wed Aug 18 16:45:34 2010 for mDictionary by 1.6.3
diff --git a/doc/html/classTranslation.html b/doc/html/classTranslation.html index 166255d..13c0f6c 100644 --- a/doc/html/classTranslation.html +++ b/doc/html/classTranslation.html @@ -45,7 +45,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Translation Class Reference
-
Keeping raw form of translation to be parsed only when needed. +
/file translation.h More...

#include <translation.h>
@@ -55,7 +55,8 @@ Inheritance diagram for Translation:

- + +
@@ -68,9 +69,20 @@ Inheritance diagram for Translation: bool

operator== (Translation *translation)

virtual QString dictionaryInfo () const =0

virtual QString toHtml () const =0

+bool isBookmark () const

whether given translation is taken from bookmarks

void setBookmark (bool b)

Protected Attributes

+bool _bookmark

Detailed Description

Keeping raw form of translation to be parsed only when needed.

/file translation.h

Interface for translation instances

See also:: Translation

Author:: Bartosz Szatkowski <bulislaw@linux.com>

Translation is kind of GoF proxy, it stores key:translation pair and provide it in lazy way -> key is available always, but translation is fetched as late as possible

Member Function Documentation

@@ -88,7 +100,7 @@ bool operator== (

Returns:: dictionary information (plugin name, languages, <logo> etc)\ to be displayed in translation table header

Implemented in TranslationXdxf.

Implemented in BookmarkTranslation, and TranslationXdxf.

Backbone	Inner part of dictionary - glues together GUI and plugins
AboutWidget
Backbone	/file backbone.cpp
Bookmarks	Bookmarks are way to store words that You think You will need to search for often
BookmarksWidget
BookmarkTranslation	/file BookmarkTranslation.h
CommonDictInterface	Interface for dict engines plugins
DictDialog	Interface for plugin dialog provider
DictManagerWidget	Implements dictionaries management widget
History
HistoryListDialog	Implements history list dialog
MainWindow	Implements interface for GUI
Ui::MainWindow
MenuTabWidget	Menu's main widget, which will hold all submenu's widgets
MenuWidget	Displays custom menu with tab widget containing all submenus
SearchBarWidget	Displays search bar
Settings	Plugin specific configuration
Translation	Keeping raw form of translation to be parsed only when needed
Settings	Plugins or dictionaries may need to keep some of configuration between sessions, moreover Backbone or GUI may want store some additional info in plugin Settings
SettingsWidget
Translation	/file translation.h
TranslationPtr
TranslationWidget	Displays translation of word found in dictionaries
TranslationWidgetAutoResizer
TranslationXdxf
Ui_MainWindow
WelcomeScreenWidget
WordListProxyStyle
WordListWidget	Displays list of words found in dictionaries
XdxfCachingDialog
XdxfDictDialog	Implementation of DictDialog interface for xdxf plugin
XdxfLoadDialog	Displays dialog which allow user to add new xdxf dictionary
XdxfPlugin

toHtml() const (defined in TranslationPtr)	TranslationPtr	`[inline]`
TranslationPtr(Translation *tr) (defined in TranslationPtr)	TranslationPtr	`[inline]`

Public Member Functions
+	TranslationPtr (Translation *tr)
+QString	toHtml () const

drawPrimitive(PrimitiveElement element, const QStyleOption option, QPainter painter, const QWidget *widget) const (defined in WordListProxyStyle)	WordListProxyStyle
WordListProxyStyle() (defined in WordListProxyStyle)	WordListProxyStyle

addBookmark(QList< Translation * >)	WordListWidget	`[signal]`
lockList()	WordListWidget	`[slot]`
mouseReleaseEvent(QMouseEvent *event) (defined in WordListWidget)	WordListWidget	`[protected]`
removeBookmark(QList< Translation * >)	WordListWidget	`[signal]`
resizeEvent(QResizeEvent *event) (defined in WordListWidget)	WordListWidget	`[protected]`
showSearchResults(QHash< QString, QList< Translation * > >)	WordListWidget	`[slot]`
showTranslation(QList< Translation * >)	WordListWidget	`[signal]`
unlockList()	WordListWidget	`[slot]`
	Unlocks words list.
Signals
void	showTranslation (QList< Translation * >)
+void	addBookmark (QList< Translation * >)
	Request to add selected word to bookmarks.
+void	removeBookmark (QList< Translation * >)
	Request to remove selected word from bookmarks.
Public Member Functions
	WordListWidget (QWidget *parent=0)
Protected Member Functions
+void	mouseReleaseEvent (QMouseEvent *event)
+void	resizeEvent (QResizeEvent *event)

Public Member Functions
+	AboutWidget (GUIInterface *parent=0)

addNewDictionary(CommonDictInterface *)	GUIInterface	`[signal]`
addToBookmarks(QList< Translation * >) (defined in GUIInterface)	GUIInterface	`[signal]`
addToHistory(QList< Translation * >)=0	GUIInterface	`[pure virtual, slot]`
exactSearch()	GUIInterface
getDictionaries()=0	GUIInterface	`[pure virtual]`
setBusy()	GUIInterface	`[signal]`
setExactSearch(bool exactSearch)	GUIInterface
setIdle()	GUIInterface	`[signal]`
setSettings(Settings *)=0 (defined in GUIInterface)	GUIInterface	`[pure virtual]`
settings()=0 (defined in GUIInterface)	GUIInterface	`[pure virtual]`
showHistory()=0	GUIInterface	`[pure virtual, slot]`
showTranslation(QStringList)	GUIInterface	`[signal]`
showWordList(QHash< QString, QList< Translation * > >)	GUIInterface	`[signal]`
	Emited when user wants to remove dictionary.
void	selectedDictionaries (QList< CommonDictInterface * >)
	Emited when user changes dictionaries active/inactive states.
+void	addToBookmarks (QList< Translation * >)
Public Member Functions
	GUIInterface (QWidget *parent=0)
	Indicates if GUI is in exact search mode.
void	setExactSearch (bool exactSearch)
	Sets GUI exact search mode.
+virtual Settings *	settings ()=0
+virtual void	setSettings (Settings *)=0

Public Member Functions
+	WelcomeScreenWidget (QWidget *parent=0)

Public Member Functions
+void	drawPrimitive (PrimitiveElement element, const QStyleOption option, QPainter painter, const QWidget *widget) const

cancelCaching() (defined in XdxfCachingDialog)	XdxfCachingDialog	`[signal]`
reject() (defined in XdxfCachingDialog)	XdxfCachingDialog	`[slot]`
XdxfCachingDialog(XdxfPlugin *parent=0) (defined in XdxfCachingDialog)	XdxfCachingDialog	`[explicit]`

Public Slots
+void	reject ()
Signals
+void	cancelCaching ()
Public Member Functions
+	XdxfCachingDialog (XdxfPlugin *parent=0)

void XdxfPlugin::updateCachingProgress	(	int	_t1,
		int	_t2
	)			`[signal]`

dicitonaryFilePath()	XdxfSettingsDialog
generateCache()	XdxfSettingsDialog
getSettings(XdxfPlugin plugin, QWidget parent) (defined in XdxfSettingsDialog)	XdxfSettingsDialog	`[static]`
XdxfSettingsDialog(XdxfPlugin plugin, QWidget parent=0) (defined in XdxfSettingsDialog)	XdxfSettingsDialog	`[explicit]`

AboutWidget.h [code]
backbone.h [code]
Bookmarks.h [code]
BookmarksWidget.h [code]
BookmarkTranslations.h [code]
CommonDictInterface.h [code]
DictDialog.h [code]
DictManagerWidget.h [code]	Dictionary management widget
MenuWidget.h [code]	Implements custom menu
SearchBarWidget.h [code]	Implements search bar
settings.h [code]
SettingsWidget.h [code]
test.h [code]
translation.h [code]
TranslationWidget.h [code]	Implements translation widget
TranslationWidgetAutoResizer.h [code]	Implements translation widget auto resizer
TranslationXdxf.h [code]
ui_MainWindow.h [code]
build-desktop/ui_MainWindow.h [code]
WelcomeScreenWidget.h [code]
WordListProxyStyle.h [code]
WordListWidget.h [code]
XdxfCachingDialog.h [code]
XdxfDictDialog.h [code]
XdxfLoadDialog.h [code]
xdxfplugin.h [code]

AboutWidget.h

BookmarkTranslations.h

BookmarksWidget.h

Bookmarks.h

SettingsWidget.h

WelcomeScreenWidget.h

WordListProxyStyle.h

XdxfCachingDialog.h

Class List

ui_MainWindow.h

AboutWidget Member List

AboutWidget Class Reference

Public Member Functions

Backbone Member List

Backbone Class Reference

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

BookmarkTranslation Member List

BookmarkTranslation Class Reference

Public Member Functions

Detailed Description

Member Function Documentation

Bookmarks Member List

Bookmarks Class Reference

Public Member Functions

Detailed Description

Member Function Documentation

BookmarksWidget Member List

BookmarksWidget Class Reference

Signals

Public Member Functions

Detailed Description

GUIInterface Member List

Public Member Functions

Detailed Description

MainWindow Member List

Protected Member Functions

MenuWidget Member List

Public Slots

Public Member Functions

Settings Class Reference

Detailed Description

Member Function Documentation

SettingsWidget Member List

SettingsWidget Class Reference

Public Member Functions

Protected Member Functions

Translation Member List

Translation Class Reference

Protected Attributes

Detailed Description

Member Function Documentation

TranslationPtr Member List

TranslationPtr Class Reference

Public Member Functions

TranslationXdxf Member List

Ui::MainWindow Class Reference

Ui::MainWindow Class Reference

Public Attributes

WelcomeScreenWidget Member List

WelcomeScreenWidget Class Reference

Public Member Functions

WordListProxyStyle Member List

WordListProxyStyle Class Reference

Public Member Functions

WordListWidget Member List

Signals

Public Member Functions

Protected Member Functions

Detailed Description

XdxfCachingDialog Member List

XdxfCachingDialog Class Reference

Public Slots

Signals

Public Member Functions

Signals

Public Member Functions