ILinksUIPanelPrefs Class Reference

#include <ILinksUIPanelPrefs.h>

Inheritance diagram for ILinksUIPanelPrefs:

Public Types
enum	{ kDefaultIID = IID_ILINKSUIPANELPREFS }

Public Member Functions
virtual IDataBase *	GetCurrentDocDB () const =0
virtual void	SetCurrentDocDB (IDataBase *newDocDB)=0
virtual int32	GetCurrentRowHeight () const =0
virtual void	SetCurrentRowHeight (int32 newHeight)=0
virtual int32	GetNumInfoProviders () const =0
virtual ILinkInfoProvider *	QueryNthInfoProvider (int32 nth) const =0
virtual int32	GetNumShowingInfoColumns () const =0
virtual ILinkInfoProvider *	QueryNthShowingInfoColumn (int32 nth) const =0
virtual void	SetShowingInfoColumns (const K2Vector< ILinkInfoProvider * > columnProviders)=0
virtual int32	GetNthColumnWidth (int32 nth) const =0
virtual void	SetColumnWidths (const K2Vector< int32 > &columnWidths)=0
virtual void	GetColumnWidths (K2Vector< int32 > &columnWidths) const =0
virtual int32	GetNumMoreInfoProviders () const =0
virtual ILinkInfoProvider *	QueryNthMoreInfoProvider (int32 nth) const =0
virtual void	SetMoreInfoProviders (const K2Vector< ILinkInfoProvider * > infoProviders)=0
virtual const ILinkInfoProvider *	GetSortInfoProvider () const =0
virtual const ILinkInfoProvider *	GetSecondarySortInfoProvider () const =0
virtual void	SetSortInfoProvider (const ILinkInfoProvider *newSorter)=0
virtual void	SetSortLinksAscending (bool16 ascend)=0
virtual bool16	GetSortLinksAscending () const =0
virtual void	SetShowLinkThumbnail (bool16 showThumbnail)=0
virtual bool16	GetShowLinkThumbnail () const =0
virtual void	SetShowLinkInfoThumbnail (bool16 showThumbnail)=0
virtual bool16	GetShowLinkInfoThumbnail () const =0
virtual void	SetCollapseMultipleLinksToSameResource (bool16 collapse)=0
virtual bool16	GetCollapseMultipleLinksToSameResource () 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

Detailed Description

This interface provides access to the settings for the Links UI panel.

Member Enumeration Documentation

anonymous enum

Default IID to be used by UseDefaultIID()

Member Function Documentation

virtual bool16 ILinksUIPanelPrefs::GetCollapseMultipleLinksToSameResource ( ) const

pure virtual

Get the pref to collapse multiple links to same resource

virtual void ILinksUIPanelPrefs::GetColumnWidths ( K2Vector< int32 > &  columnWidths ) const

pure virtual

Get the widths for all the columns

virtual IDataBase* ILinksUIPanelPrefs::GetCurrentDocDB ( ) const

pure virtual

Get the current document DB that the Links panel is showing

virtual int32 ILinksUIPanelPrefs::GetCurrentRowHeight ( ) const

pure virtual

Get the current row height for rows in the links panel treeview

virtual int32 ILinksUIPanelPrefs::GetNthColumnWidth ( int32  nth ) const

pure virtual

Get the width of the nth Column in the links panel

virtual int32 ILinksUIPanelPrefs::GetNumInfoProviders ( ) const

pure virtual

Get the total number of registered ILinkInfoProviders

virtual int32 ILinksUIPanelPrefs::GetNumMoreInfoProviders ( ) const

pure virtual

Get how many ILinkInfoProviders are currently showing in the links panel 'More info' section.

virtual int32 ILinksUIPanelPrefs::GetNumShowingInfoColumns ( ) const

pure virtual

Get the number of columns showing in the links panel. Each column is associated with one ILinkInfoProvider

virtual const ILinkInfoProvider* ILinksUIPanelPrefs::GetSecondarySortInfoProvider ( ) const

pure virtual

Get the ILinkInfoProvider being used as the secondary sort in the links panel. Can return nil if not currently sorted.

virtual bool16 ILinksUIPanelPrefs::GetShowLinkInfoThumbnail ( ) const

pure virtual

Get the pref to show the thumbnail in the info section of the links panel.

virtual bool16 ILinksUIPanelPrefs::GetShowLinkThumbnail ( ) const

pure virtual

Get the pref to show the thumbnail in the name column of the links panel tree view.

virtual const ILinkInfoProvider* ILinksUIPanelPrefs::GetSortInfoProvider ( ) const

pure virtual

Get the ILinkInfoProvider being used as the primary sort in the links panel. Can return nil if not currently sorted.

virtual bool16 ILinksUIPanelPrefs::GetSortLinksAscending ( ) const

pure virtual

Get the flag to sort ascending or descending.

virtual ILinkInfoProvider* ILinksUIPanelPrefs::QueryNthInfoProvider ( int32  nth ) const

pure virtual

Get the nth registered ILinkInfoProvider

virtual ILinkInfoProvider* ILinksUIPanelPrefs::QueryNthMoreInfoProvider ( int32  nth ) const

pure virtual

Get an addref'd pointer to the nth ILinkInfoProvider showing in the 'more info' section

virtual ILinkInfoProvider* ILinksUIPanelPrefs::QueryNthShowingInfoColumn ( int32  nth ) const

pure virtual

Gets an addref'd pointer to the nth ILinkInfoProvider which is currently showing as a column in the links panel

virtual void ILinksUIPanelPrefs::SetCollapseMultipleLinksToSameResource ( bool16  collapse )

pure virtual

Set the pref to collapse multiple links to same resource

virtual void ILinksUIPanelPrefs::SetColumnWidths ( const K2Vector< int32 > &  columnWidths )

pure virtual

Set the widths for all the columns

virtual void ILinksUIPanelPrefs::SetCurrentDocDB ( IDataBase *  newDocDB )

pure virtual

Set the current document DB that the Links panel is showing

virtual void ILinksUIPanelPrefs::SetCurrentRowHeight ( int32  newHeight )

pure virtual

Set the current row height for rows in the links panel treeview

virtual void ILinksUIPanelPrefs::SetMoreInfoProviders ( const K2Vector< ILinkInfoProvider * >  infoProviders )

pure virtual

Set which ILinkInfoProviders should be used in the more info section. ILinksUIPanelPrefs does not take ownership of any refs on the pointers. Caller is expected to release any owned refs.

virtual void ILinksUIPanelPrefs::SetShowingInfoColumns ( const K2Vector< ILinkInfoProvider * >  columnProviders )

pure virtual

Sets which ILinkInfoProviders should be shown as columns in the links panel. ILinksUIPanelPrefs does not take ownership of any refs on the pointers. Caller is expected to release any owned refs.

virtual void ILinksUIPanelPrefs::SetShowLinkInfoThumbnail ( bool16  showThumbnail )

pure virtual

Set the pref to show the thumbnail in the info section of the links panel.

virtual void ILinksUIPanelPrefs::SetShowLinkThumbnail ( bool16  showThumbnail )

pure virtual

Set the pref to show the thumbnail in the name column of the links panel tree view.

virtual void ILinksUIPanelPrefs::SetSortInfoProvider ( const ILinkInfoProvider *  newSorter )

pure virtual

Set the ILinkInfoProvider being used as the primary sort in the links panel. The old primary sort will become the secondary sort.

virtual void ILinksUIPanelPrefs::SetSortLinksAscending ( bool16  ascend )

pure virtual

Set the flag to sort ascending or descending.