InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ICdlChartSuite Class Referenceabstract
CandleChart

#include <ICdlChartSuite.h>

Inheritance diagram for ICdlChartSuite:
IPMUnknownCPMUnknown< ICdlChartSuite >CdlChartSuiteASBCdlChartSuiteCSBCdlChartSuiteLayoutCSB

Public Types

enum  { kDefaultIID = IID_ICDLCHARTSUITE }
 

Public Member Functions

virtual bool16 CanGetChartName ()=0
 
virtual ErrorCode GetChartName (WideString &outChartName)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

From SDK sample; suite interface that extends the capability of the selection so that it can manipulate the value of ICdlChartData associated with the objects that are currently selected.

See Also
Selection fundamentals chapter in Programming Guide

Member Function Documentation

virtual bool16 ICdlChartSuite::CanGetChartName ()
pure virtual

Check if it is able to get name of the chart.

Returns
kTrue if the caller can apply IBPIData to the objects that are currently selected, kFalse otherwise.

Implemented in CdlChartSuiteCSB, and CdlChartSuiteASB.

virtual ErrorCode ICdlChartSuite::GetChartName (WideString & outChartName)
pure virtual

Apply the given value for CdlStockChartData to the objects that are currently selected.

Precondition
ICdlChartSuite::CanGetChartName returns kTrue
Parameters
outChartNameOUT the name of the stock chart data.
Returns
kSuccess if the value was applied successfully, kFailure otherwise.

Implemented in CdlChartSuiteCSB, and CdlChartSuiteASB.