gui::TreeData Class Reference

Tree parameters shared between tree and tree items. More...

#include <treedata.h>

Public Member Functions
	TreeData (TreeWindow parent, Q_ListView tree, BaseCore base, MultiTreeWindow multi)
	~TreeData ()
TreeWindow *	parent ()
Q_ListView *	tree ()
MultiTreeWindow *	multi ()
BaseCore *	base ()
void	add (TreeItemRef *it)
void	remove (TreeItemRef *it)
void	remove (const QString &ref)
TreeItemRef *	find (const QString &ref)
void	clear ()
void	checkSetting (bool &target, const QString &key, bool defaultValue=true)
void	update ()
bool	sortDict ()
bool	showDict ()
bool	showODict ()
bool	showOutline ()
bool	showAnnot ()
bool	showGraphic ()
bool	showPage ()
bool	showSimple ()
bool	showStream ()
bool	isDirty ()
void	resetDirty ()
bool	needReload ()
void	resetReload ()
Private Attributes
TreeWindow *	_parent
MultiTreeWindow *	_multi
Q_ListView *	_tree
BaseCore *	_base
Q_Dict< TreeItemRef >	refs
bool	show_simple
bool	show_dict
bool	show_dict_sort
bool	show_graphic
bool	show_annot
bool	show_odict
bool	show_outline
bool	show_page
bool	show_stream
bool	dirty
bool	needreload

Detailed Description

Tree parameters shared between tree and tree items.

Storage class holding Tree Data that need to be shared between tree window and its items and also holding setting related to what items to show in tree

Constructor & Destructor Documentation

gui::TreeData::TreeData	(	TreeWindow *	parent,
		Q_ListView *	tree,
		BaseCore *	base,
		MultiTreeWindow *	multi
	)

Constructor of TreeData

Parameters:

	parent	TreeWindow holding these data
	tree	Tree holding list items
	base	Scripting base
	multi	MultiTreeWindow holding given tree

gui::TreeData::~TreeData ( )

default destructor

Member Function Documentation

void gui::TreeData::add ( TreeItemRef * it )

Add TreeItem that holds a CRef into list Will do nothing on TreeItems that do not hold a CRef.

Parameters:

it

TreeItem holding CRef

Referenced by gui::TreeItemRef::setOpen().

BaseCore * gui::TreeData::base ( )

Return scripting base associated with this window

Returns:: BaseCore

Referenced by gui::TreeItemPdfOperator::getQSObject(), gui::TreeItemPage::getQSObject(), gui::TreeItemDict::getQSObject(), gui::TreeItemCStream::getQSObject(), gui::TreeItemArray::getQSObject(), and gui::TreeItem::getQSObject().

void gui::TreeData::checkSetting	(	bool &	target,
		const QString &	key,
		bool	defaultValue = `true`
	)

Check if setting have changed, updating if necessary. If setting is changed, set dirty to true.

Parameters:

	key	Setting to check
	target	Pointer to setting to check
	defaultValue	Default value

Referenced by update().

void gui::TreeData::clear ( )

Clear list of TreeItems with CRef

References refs.

Referenced by gui::TreeWindow::clear().

TreeItemRef * gui::TreeData::find ( const QString & ref )

Look in list for a treeItem with given reference and return it.

Parameters:

ref

Reference in string format

Returns:: TreeItem with given reference, or NULL if nothing found

Referenced by gui::TreeItemRef::setOpen().

bool gui::TreeData::isDirty ( )

Return state of 'dirty' flag

Returns:: variable 'dirty'

Referenced by gui::TreeWindow::updateTreeSettings().

MultiTreeWindow * gui::TreeData::multi ( )

Return parent multitree (MultiTreeWindow) associated with this TreeData

Returns:: parent MultiTreeWindow

Referenced by gui::TreeItem::remove(), and gui::TreeItemAbstract::~TreeItemAbstract().

bool gui::TreeData::needReload ( )

Return true, if the tree should be reloaded because the settings changed since last time the tree was reloaded, false if the tree does not need reloading