FindRelatedPresCriteria Struct Reference

#include <DocumentPresFindCriteria.h>

Static Public Attributes
static binary_presentation_predicate	accept_all
static binary_presentation_predicate	is_active
static binary_presentation_predicate	is_frontmost_in_tabgroup
static binary_presentation_predicate	is_layout
static binary_presentation_predicate	is_floating
static binary_presentation_predicate	is_minimized
static binary_presentation_predicate	is_autonomous
static binary_presentation_predicate	is_visible
static binary_presentation_predicate	IC_in_layoutmode
static binary_presentation_predicate	IC_in_galleymode
static binary_presentation_predicate	IC_in_storymode
static binary_presentation_predicate	IC_in_galleyorstory
static binary_presentation_predicate	is_samekind
static binary_presentation_predicate	isnot_samekind
static binary_presentation_predicate	is_samedocument
static binary_presentation_predicate	isnot_samedocument
static FindRelatedPresentation_PreferCriteria	empty

Detailed Description

FindRelatedPresCriteria: are binary predicates (two parameter boolean functions) used to select and order the set of document presentations relative to a particular one returned from IDocumentUIUtils::FindRelatedPresentations.

Examples: Find all other presentations of the same kind on the same document as a particlar presentation, ordered loosely by activation. whichDocument: document acceptCriteria: is_samekind preferCriteria: is_active + is_frontmost_in_tabgroup includeMe: kFalse

Code snippet: PresentationSequence relatedPresentations; FindRelatedPresentation_Criteria require = FindRelatedPresCriteria::is_samekind; FindRelatedPresentation_PreferCriteria prefer; prefer.push_back(FindRelatedPresCriteria::is_active); prefer.push_back(FindRelatedPresCriteria::is_frontmost_in_tabgroup);

int32 count = Utils<IDocumentUIUtils>()->FindRelatedPresentations(document, active, relatedPresentations, require, prefer);