InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IScrollBarPanoramaSync Class Referenceabstract

#include <IScrollBarPanoramaSync.h>

Inheritance diagram for IScrollBarPanoramaSync:
IPMUnknown

Public Member Functions

virtual void Init (IControlView *scrollBarX, IControlView *scrollBarY, IPanorama *panorama, bool16 bInhibitCentering=kFalse)=0
 
virtual void SizeChanged ()=0
 
virtual void UpdateScrollBars ()=0
 
virtual void UpdatePanorama (bool16 isVertical, int32 scrollDelta)=0
 
virtual ICounterControlDataGetScrollBarX () const =0
 
virtual ICounterControlDataGetScrollBarY () const =0
 
virtual IPanoramaGetPanorama () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface used to keep a panorama synced with the scrollbar widget(s) controlling it.

An IScrollBarPanoramaSync implementation is combined with an IObserver implementation,

as in kScrollBarPanoramaSyncBoss or kGridScrollBarPanoramaSyncBoss.

See Also
IPanorama

Member Function Documentation

virtual IPanorama* IScrollBarPanoramaSync::GetPanorama () const
pure virtual

Get the panorama.

virtual ICounterControlData* IScrollBarPanoramaSync::GetScrollBarX () const
pure virtual

Get the horizontal scroll bar.

virtual ICounterControlData* IScrollBarPanoramaSync::GetScrollBarY () const
pure virtual

Get the vertical scroll bar.

virtual void IScrollBarPanoramaSync::Init (IControlViewscrollBarX,
IControlViewscrollBarY,
IPanoramapanorama,
bool16 bInhibitCentering = kFalse 
)
pure virtual

Initialize the interface, and attach the associated observer to the panorama, window and scroll bar(s).

Parameters
scrollBarXIN the horizontal scroll bar view
scrollBarYIN the vertical scroll bar view
panoramaIN the panorama to be scrolled
bInhibitCenteringIN if true, inhibit centering the panorama as it grows or shrinks.
virtual void IScrollBarPanoramaSync::SizeChanged ()
pure virtual

Adjust the scroll bars and panorama after the size of the panorama has changed.

virtual void IScrollBarPanoramaSync::UpdatePanorama (bool16 isVertical,
int32 scrollDelta 
)
pure virtual

Update the panorama to match the scroll bars.

Parameters
isVerticalIN scroll vertically or horizontally
scrollDeltaIN how much to scroll
virtual void IScrollBarPanoramaSync::UpdateScrollBars ()
pure virtual

Update the scroll bars to match the panorama (after a resize). Includes enabling and disabling the scroll bars as necessary if the entire panorama becomes visible.