Facade::IStoryViewTableFacade Class Reference

Inheritance diagram for Facade::IStoryViewTableFacade:

Public Types
enum	{ kDefaultIID = IID_ISTORYVIEWTABLEFACADE }
enum	OrderType { kOrderByRows, kOrderByColumns }

Public Member Functions
virtual ErrorCode	SetCollapsed (const UIDList &tableModelRefs, bool collapsed)=0
virtual ErrorCode	GetIsCollapsed (const UIDList &tableModelRefs, std::vector< bool > &collapsed) const =0
virtual ErrorCode	SetDisplayOrder (const UIDList &tableModelRefs, OrderType order)=0
virtual ErrorCode	GetDisplayOrder (const UIDList &tableModelRefs, std::vector< OrderType > &order) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum Facade::IStoryViewTableFacade::OrderType

OrderType. Specifies the order in which table cells are displayed.

Enumerator
kOrderByRows	kOrderByRows - Order table cell display in row order (i.e. display all of row 1 first then all of row 2 etc).
kOrderByColumns	kOrderByColumns - Order table cell display in column order.

Member Function Documentation

virtual ErrorCode Facade::IStoryViewTableFacade::GetDisplayOrder ( const UIDList &  tableModelRefs, std::vector< OrderType > &  order  ) const

pure virtual

Get the order in which table cells are displayed for a set of tables

Parameters

tableModelRefs	[IN]: UID list of of tables to set the display order of.
order	[OUT]: A vector with an entry for each table specified in tableModelRefs, entry value specifies display order for a table

Returns

kSuccess if successful. Otherwise an error code is returned.

virtual ErrorCode Facade::IStoryViewTableFacade::GetIsCollapsed ( const UIDList &  tableModelRefs, std::vector< bool > &  collapsed  ) const

pure virtual

Get whether tables are currently shown collapsed or expanded.

Parameters

tableModelRefs	[IN]: UIDs of tables to retrieve collapse information for.
collapsed	[OUT]: list of tables collapsed view states. True value indicates table is collapsed and false uncollapsed.

Returns

kSuccess if was able to retrieve collapse view states for tables in the list. Otherwise an error code is returned.

virtual ErrorCode Facade::IStoryViewTableFacade::SetCollapsed ( const UIDList &  tableModelRefs, bool  collapsed  )

pure virtual

Set the collapsed state of a tables

Parameters

tableModelRefs	[IN]: UID list of of tables to set collapsed or uncollapsed.
collapsed	[IN]: true to set tables to a collapsed view state, false to expand.

Returns

kSuccess if successful. Otherwise an error code is returned.

virtual ErrorCode Facade::IStoryViewTableFacade::SetDisplayOrder ( const UIDList &  tableModelRefs, OrderType  order  )

pure virtual

Set the order in which table cells are displayed for a set of tables

Parameters

tableModelRefs	[IN]: UID list of of tables to set the display order of.
order	[IN]: Specify the order to set the table cell display order with this param.

Returns

kSuccess if successful. Otherwise an error code is returned.