InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
BscMnuSuiteLayoutCSB Class Reference
Inheritance diagram for BscMnuSuiteLayoutCSB:
CPMUnknown< IBscMnuSuite >IBscMnuSuiteIPMUnknown

Public Member Functions

 BscMnuSuiteLayoutCSB (IPMUnknown *iBoss)
 
virtual ~BscMnuSuiteLayoutCSB (void)
 
virtual bool16 CanApplyBscMnu (void)
 
- Public Member Functions inherited from CPMUnknown< IBscMnuSuite >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IBscMnuSuite
enum  { kDefaultIID = IID_IBSCMNU_ISUITE }
 
- Protected Member Functions inherited from CPMUnknown< IBscMnuSuite >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IBscMnuSuite >
HelperInterface fHelperInterface
 

Detailed Description

Layout concrete selection boss (CSB) IBscMnuSuite implementation. The suite implementations on the CSBs are responsible for doing all of the model specific work. The implementation of a CSB suite deals with the model format of its owning boss. The only information that the suite should need is from sibling interfaces on the CSB, primarily the target interface. This interface specifies which items to act upon. For the LayoutCSB, the target interface is ILayoutTarget which wraps a UIDList. So usually you see the methods in this CSB will first get an InterfacePtr to a ILayoutTarget, then it gets the UIDList of the selected items from the pointer.

Note that the client does not interact with the CSB (which has all the real implementation of the suite) directly, the client interacts with the ASB only. Also note that the Suite API shouldn't contain model data that is specific to a selection format (layout uidLists, text model/range, etc) so that the client code can be completely decoupled from the underlying CSB.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * BscMnuSuiteLayoutCSB::BscMnuSuiteLayoutCSB (IPMUnknowniBoss)

Constructor.

Parameters
iBossinterface ptr from boss object on which this interface is aggregated.
BscMnuSuiteLayoutCSB::~BscMnuSuiteLayoutCSB (void )
virtual

Destructor.

Member Function Documentation

bool16 BscMnuSuiteLayoutCSB::CanApplyBscMnu (void )
virtual