AttachableScrollBar Class Reference

An AttachableScrollBar is a scroll bar that can be attached to multiple items and so control their scrolling. Uses floats internally, not ints, allowing for (external) control of zooming. More...

#include <AttachableScrollBar.h>

Inheritance diagram for AttachableScrollBar:

Collaboration diagram for AttachableScrollBar:

Public Member Functions
	AttachableScrollBar (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxSB_HORIZONTAL)
	~AttachableScrollBar (void)
void	OnScroll (wxScrollEvent &event)
void	SetViewInfo (ViewInfo *view)
void	SetScrollBarFromViewInfo ()
void	SetViewInfoFromScrollBar ()

Public Attributes
ViewInfo *	mpViewInfo

Detailed Description

An AttachableScrollBar is a scroll bar that can be attached to multiple items and so control their scrolling. Uses floats internally, not ints, allowing for (external) control of zooming.

Limitations:

• Currently horizontal only.
• Attached item repainting not yet supported. Instead for now place the attached windows in an InvisiblePanel, and rely on refreshing of the invisible panel to refresh each of the objects.
• Currently closely tied to the mViewInfo class. This will change to make the class much more generic.

Definition at line 24 of file AttachableScrollBar.h.

Constructor & Destructor Documentation

AttachableScrollBar()

AttachableScrollBar::AttachableScrollBar	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxSB_HORIZONTAL
	)

Definition at line 41 of file AttachableScrollBar.cpp.

               :
   wxScrollBar( parent, id, pos, size, style )
{
   mpViewInfo = NULL;
}

~AttachableScrollBar()

AttachableScrollBar::~AttachableScrollBar

(

void

)

Definition at line 52 of file AttachableScrollBar.cpp.

{
}

Member Function Documentation

OnScroll()

void AttachableScrollBar::OnScroll

(

wxScrollEvent &

event

)

Definition at line 95 of file AttachableScrollBar.cpp.

{
   if( mpViewInfo == NULL )
   {
      event.Skip();
      return;
   }
   SetViewInfoFromScrollBar();
   event.Skip(); // This is so that the parent control can refresh whatever it needs to...
}

References mpViewInfo, and SetViewInfoFromScrollBar().

Here is the call graph for this function:

SetScrollBarFromViewInfo()

void AttachableScrollBar::SetScrollBarFromViewInfo

(

)

Definition at line 57 of file AttachableScrollBar.cpp.

{
   // FIXME: PRL Aug 2015: Screen Width in Viewinfo Not needed?
#if 0
   ViewInfo & mViewInfo = *mpViewInfo;
 
   mViewInfo.sbarTotal = (int) (mViewInfo.GetTotalWidth());
   mViewInfo.sbarScreen = (int) (mViewInfo.GetScreenWidth());
   mViewInfo.sbarH = (int) (mViewInfo.GetBeforeScreenWidth());
 
   SetScrollbar(mViewInfo.sbarH, mViewInfo.sbarScreen,
                        mViewInfo.sbarTotal, mViewInfo.sbarScreen, TRUE);
#endif
}

References ViewInfo::GetBeforeScreenWidth(), and mpViewInfo.

Referenced by SetViewInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

SetViewInfo()

void AttachableScrollBar::SetViewInfo

(

ViewInfo *

view

)

Definition at line 89 of file AttachableScrollBar.cpp.

{
   mpViewInfo = view;
   SetScrollBarFromViewInfo();
}

References mpViewInfo, and SetScrollBarFromViewInfo().

Here is the call graph for this function:

SetViewInfoFromScrollBar()

void AttachableScrollBar::SetViewInfoFromScrollBar

(

)

Definition at line 73 of file AttachableScrollBar.cpp.

{
   // FIXME: PRL Aug 2015: Screen Width in Viewinfo Not needed? 
#if 0
   ViewInfo & mViewInfo = *mpViewInfo;
 
   int hlast = mViewInfo.sbarH;
 
   mViewInfo.sbarH = GetThumbPosition();
 
   if (mViewInfo.sbarH != hlast)
     mViewInfo.SetBeforeScreenWidth(mViewInfo.sbarH);
#endif
}

References mpViewInfo.

Referenced by OnScroll().

Here is the caller graph for this function:

Member Data Documentation

mpViewInfo

ViewInfo* AttachableScrollBar::mpViewInfo

Definition at line 42 of file AttachableScrollBar.h.

Referenced by OnScroll(), SetScrollBarFromViewInfo(), SetViewInfo(), and SetViewInfoFromScrollBar().

---

The documentation for this class was generated from the following files:

• AttachableScrollBar.h
• AttachableScrollBar.cpp