All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OP_GalleryManager Class Reference

#include <OP_GalleryManager.h>

Public Member Functions

int getNumGalleries () const
OP_GallerygetGallery (int index) const
OP_GalleryfindGallery (const char *path) const
OP_GalleryinstallGallery (const char *path, bool create, bool addtohistory)
bool removeGallery (const char *path)
void removeGallery (int index)
void getMatchingEntries (OP_GalleryEntryList &found, OP_Node *node, bool include_hidden=true) const
void getMatchingEntries (OP_GalleryEntryList &found, const char *namepattern, const char *labelpattern, const char *keywordpattern, const char *category, const char *optable, const char *optype, bool include_hidden=true) const
void getKeywords (UT_StringArray &keywords, const char *optable=NULL)
void addExtraCategory (const char *optable, const char *category)
const UT_StringArraygetExtraCategories (const char *optable) const
 Gets a list of extra categories added for the given optable. More...
void refreshAll (bool force)
void purgeInvalidGalleries ()
void sendEvent (OP_GalleryChangeType changetype)
OP_GalleryNotifiergetEventNotifier ()
void getInstalledGalleryPaths (UT_StringArray &gallerypaths, bool includestandard, bool includehda) const
void getCommonGalleryDirs (UT_StringArray &paths)
void setCreateBackups (bool createbackups)
bool getCreateBackups () const
bool canSavePreferences () const
const UT_StringgetDefaultGallery ()
const UT_StringArraygetCategorySortOrder (const char *parent_category=NULL)

Static Public Member Functions

static OP_GalleryManagergetManager ()

Protected Member Functions

 OP_GalleryManager ()
virtual ~OP_GalleryManager ()
void clear ()
void scanGalleriesPath ()

Static Protected Member Functions

static void fullyQualifyGalleryPath (UT_String &path)

Detailed Description

Definition at line 32 of file OP_GalleryManager.h.

Constructor & Destructor Documentation

OP_GalleryManager::OP_GalleryManager ( )
virtual OP_GalleryManager::~OP_GalleryManager ( )

Member Function Documentation

void OP_GalleryManager::addExtraCategory ( const char *  optable,
const char *  category 

Adds an extra category even if no entry subscribes to it.

optableThe context in which extra category should appear.
categoryThe category name to add.
bool OP_GalleryManager::canSavePreferences ( ) const
void OP_GalleryManager::clear ( )
OP_Gallery* OP_GalleryManager::findGallery ( const char *  path) const
static void OP_GalleryManager::fullyQualifyGalleryPath ( UT_String path)
const UT_StringArray* OP_GalleryManager::getCategorySortOrder ( const char *  parent_category = NULL)

Gets the sort order of categories (when parent name is not a string). Optionally the parent category may be provided in the form of a string encoding subcategories separated with a slash. When the parent category name is given, returns the order of sub-categories, if parent is found, otherwise ther returned array will be empty.

void OP_GalleryManager::getCommonGalleryDirs ( UT_StringArray paths)
bool OP_GalleryManager::getCreateBackups ( ) const
const UT_String& OP_GalleryManager::getDefaultGallery ( )
OP_GalleryNotifier& OP_GalleryManager::getEventNotifier ( )
const UT_StringArray* OP_GalleryManager::getExtraCategories ( const char *  optable) const

Gets a list of extra categories added for the given optable.

OP_Gallery* OP_GalleryManager::getGallery ( int  index) const
void OP_GalleryManager::getInstalledGalleryPaths ( UT_StringArray gallerypaths,
bool  includestandard,
bool  includehda 
) const
void OP_GalleryManager::getKeywords ( UT_StringArray keywords,
const char *  optable = NULL 

Returns the array of all keywords used by entries in all galleries that match the requirement of the optable.

static OP_GalleryManager& OP_GalleryManager::getManager ( )
void OP_GalleryManager::getMatchingEntries ( OP_GalleryEntryList found,
OP_Node node,
bool  include_hidden = true 
) const
void OP_GalleryManager::getMatchingEntries ( OP_GalleryEntryList found,
const char *  namepattern,
const char *  labelpattern,
const char *  keywordpattern,
const char *  category,
const char *  optable,
const char *  optype,
bool  include_hidden = true 
) const
int OP_GalleryManager::getNumGalleries ( ) const
OP_Gallery* OP_GalleryManager::installGallery ( const char *  path,
bool  create,
bool  addtohistory 
void OP_GalleryManager::purgeInvalidGalleries ( )
void OP_GalleryManager::refreshAll ( bool  force)
bool OP_GalleryManager::removeGallery ( const char *  path)
void OP_GalleryManager::removeGallery ( int  index)
void OP_GalleryManager::scanGalleriesPath ( )
void OP_GalleryManager::sendEvent ( OP_GalleryChangeType  changetype)
void OP_GalleryManager::setCreateBackups ( bool  createbackups)

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