Browser Namespace Reference

The component that allows you to narrow down the image set. More...

Classes
class	AbstractCategoryModel
	Base class for Category models. More...
class	Breadcrumb
	Information about a single breadcrumb. More...
class	BreadcrumbList
	A List of Breadcrumb's. More...
class	BrowserPage
	Information about a single page in the browser. More...
class	BrowserWidget
	The widget that makes up the Browser, and the interface to the other modules in KPhotoAlbum. More...
class	CategoryPage
	The Browser page for categories. More...
class	CenteringIconView
	QListView subclass which shows its content as icons centered in the middle. More...
class	FlatCategoryModel
	Implements a flat model for categories - ie. a model where all catergories, including subcategories, are shown. More...
class	ImageViewPage
	The page showing the actual images. More...
class	OverviewPage
	The overview page in the browser (the one containing People, Places, Show Images etc). More...
class	TreeCategoryModel
	A QAbstractItemModel subclass that represent the items of a given category as a tree. More...
Enumerations
enum	Viewer { ShowBrowser, ShowImageViewer }
Variables
const int	ItemNameRole = Qt::UserRole + 1
const int	ValueRole = Qt::UserRole + 2

---

Detailed Description

The component that allows you to narrow down the image set.

The GUI component of the browser is the BrowserWidget. This widget has a QTreeView and a CenteringIconView for displaying its content.

The class CenteringIconView is a simple QListView that is adapted to optionally centering its content.

The BrowserWidget has a list of BrowserPage's, each page represent an item that you can go backward or forward to using the back/forward buttons in the toolbar.

The BrowserPage class and its subclasses

The BrowserPage is responsible for providing an instance of QAbstractItemModel for the BrowserWidget's QTreeView and QListView. Besides that it has a number of methods telling properties of the given page ( e.g. BrowserPage::viewer() tells if the Browser or the Viewer should be used, BrowserPage::isSearchable tells if it possible to use the search bar on the page etc).

Three subclasses currently exists for the BrowserPage:

• OverviewPage - the page with (People, Places, Show images etc)
• CategoryPage - the page showing the items of a given caetegory
• ImageViewPage - represent a thumbnail view

Searching

The content of the Browser can be narrowed using the search bar, for that the class TreeFilter implements a QSortFilterProxyModel that the BrowserWidget used for filtering and sorting.

Breadcrumbs

At the bottom of the main window, a list of breadcrumbs exists for navigating the path taken in the browser. That list is made up from individual breadcrumbs of the steps. The individual breadcrumbs are represented using Breadcrumb and a list of breadcrumbs is represented using BreadcrumbList.

Models

The browser has, as mentioned, two views: a tree view and a list view (for icon mode). These are populated using instances of QAbstractItemModel which are returned from subclasses of BrowserPage.

The OverviewPage subclasses QAbstractListModel, and implement the model internally. The CategoryPage on the other is slightly more complicated, as it either needs to use a simply model for the icon view, or a more complicated one for the tree views.

For that purpose two classes exists: FlatCategoryModel (the simple one) and TreeCategoryModel (the tree version). Both classes inherits from AbstractCategoryModel, which has some common code for the two.

---

Enumeration Type Documentation

enum Browser::Viewer

Enumerator:

ShowBrowser
ShowImageViewer

---

Variable Documentation

const int Browser::ItemNameRole = Qt::UserRole + 1

Referenced by Browser::CategoryPage::activateChild(), and Browser::AbstractCategoryModel::data().

const int Browser::ValueRole = Qt::UserRole + 2

Referenced by Browser::BrowserWidget::BrowserWidget(), Browser::OverviewPage::data(), and Browser::AbstractCategoryModel::data().