nux-0.9.48

nux::ScrollView Class Reference

#include <Nux/ScrollView.h>

Inheritance diagram for nux::ScrollView:
nux::View nux::InputArea nux::Area nux::InitiallyUnownedObject nux::Focusable nux::Object nux::Trackable nux::Panel nux::TableCtrl nux::ListControl nux::TreeControl

Public Member Functions

 ScrollView (NUX_FILE_LINE_PROTO)
virtual ~ScrollView ()
void EnableVerticalScrollBar (bool b)
void EnableHorizontalScrollBar (bool b)
virtual bool SetLayout (Layout *layout)
 Set the default layout for this view.
void SetSizeMatchContent (bool b)
bool IsSizeMatchContent () const
virtual void SetGeometry (const Geometry &geo)
 Inherited from Area.
void OnSizeGrigMouseDown (int x, int y, unsigned long button_flags, unsigned long key_flags)
void OnSizeGrigMouseDrag (int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
void EmitMouseDrag (int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
virtual void ScrollLeft (float stepx, int mousedx)
virtual void ScrollRight (float stepx, int mousedx)
virtual void ScrollUp (float stepy, int mousedy)
virtual void ScrollDown (float stepy, int mousedy)
virtual void ResetScrollToLeft ()
virtual void ResetScrollToRight ()
virtual void ResetScrollToUp ()
virtual void ResetScrollToDown ()
void SetViewContentLeftMargin (int margin)
int GetViewContentLeftMargin () const
void SetViewContentRightMargin (int margin)
int GetViewContentRightMargin () const
void SetViewContentTopMargin (int margin)
int GetViewContentTopMargin () const
void SetViewContentBottomMargin (int margin)
int GetViewContentBottomMargin () const

Data Fields

int m_MouseWheelScrollSize
int m_ViewContentX
 X Position of the content.
int m_ViewContentY
 Y Position of the content.
int m_ViewContentWidth
 Width of content.
int m_ViewContentHeight
 Height of content.
int m_ViewX
 X position of the scroll view content area.
int m_ViewY
 Y position of the scroll view content area.
int m_ViewWidth
 Width of the scroll view content area.
int m_ViewHeight
 Height of the scroll view content area.
Geometry m_ViewGeometry
Geometry m_ContentGeometry
sigc::signal< void > SigTest
sigc::signal< void > sigMoveWindow
sigc::signal< void, int, int,
int, int > 
sigResize

Protected Member Functions

virtual void Draw (GraphicsEngine &GfxContext, bool force_draw)
virtual void DrawContent (GraphicsEngine &GfxContext, bool force_draw)
virtual void PostDraw (GraphicsEngine &GfxContext, bool force_draw)
virtual long ProcessEvent (Event &event, long TraverseInfo, long ProcessEventInfo)
void SetVScrollBar (VScrollBar *newVScrollBar)
 Change Vertical Scrollbar in the ScrollView.
void OnChildFocusChanged (Area *parent, Area *child)
void SwapTextureIndex ()
void SetTextureIndex (int index)
int GetTextureIndex ()
int getBorder () const
int getTopBorder () const
void setBorder (int border)
void setTopBorder (int top_border)
void FormatContent ()
virtual void PreLayoutManagement ()
virtual long PostLayoutManagement (long LayoutResult)
virtual void PositionChildLayout (float offsetX, float offsetY)
virtual long PostLayoutManagement2 (long LayoutResult)

Protected Attributes

ObjectPtr
< IOpenGLFrameBufferObject
m_FrameBufferObject
int m_TextureIndex
bool m_ReformatTexture
HScrollBarhscrollbar
VScrollBarvscrollbar
bool m_horizontal_scrollbar_enable
bool m_vertical_scrollbar_enable
int m_SizeGripDragPositionX
int m_SizeGripDragPositionY
int m_top_border
int m_border
int _delta_x
 Horizontal scrollbar offsets.
int _delta_y
 Vertical scrollbar offsets.

Constructor & Destructor Documentation

nux::ScrollView::ScrollView ( NUX_FILE_LINE_PROTO  )
virtual nux::ScrollView::~ScrollView ( ) [virtual]

Member Function Documentation

virtual void nux::ScrollView::Draw ( GraphicsEngine GfxContext,
bool  force_draw 
) [protected, virtual]

Implements nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::DrawContent ( GraphicsEngine GfxContext,
bool  force_draw 
) [protected, virtual]

Reimplemented from nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

void nux::ScrollView::EmitMouseDrag ( int  x,
int  y,
int  dx,
int  dy,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::ScrollView::EnableHorizontalScrollBar ( bool  b)
void nux::ScrollView::EnableVerticalScrollBar ( bool  b)
void nux::ScrollView::FormatContent ( ) [protected]
int nux::ScrollView::getBorder ( ) const [protected]
int nux::ScrollView::GetTextureIndex ( ) [inline, protected]

References m_TextureIndex.

int nux::ScrollView::getTopBorder ( ) const [protected]
int nux::ScrollView::GetViewContentBottomMargin ( ) const [inline]
int nux::ScrollView::GetViewContentLeftMargin ( ) const [inline]
int nux::ScrollView::GetViewContentRightMargin ( ) const [inline]
int nux::ScrollView::GetViewContentTopMargin ( ) const [inline]
bool nux::ScrollView::IsSizeMatchContent ( ) const

Check if the table size is constrained by its content.

Returns:
If the return value is true, the table size is constrained by its content.
See also:
SetSizeMatchContent

Referenced by nux::TableCtrl::CanBreakLayout().

void nux::ScrollView::OnChildFocusChanged ( Area parent,
Area child 
) [protected]

Reimplemented from nux::View.

void nux::ScrollView::OnSizeGrigMouseDown ( int  x,
int  y,
unsigned long  button_flags,
unsigned long  key_flags 
)
void nux::ScrollView::OnSizeGrigMouseDrag ( int  x,
int  y,
int  dx,
int  dy,
unsigned long  button_flags,
unsigned long  key_flags 
)
virtual void nux::ScrollView::PositionChildLayout ( float  offsetX,
float  offsetY 
) [protected, virtual]

Reimplemented from nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::PostDraw ( GraphicsEngine GfxContext,
bool  force_draw 
) [protected, virtual]

Reimplemented from nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual long nux::ScrollView::PostLayoutManagement ( long  LayoutResult) [protected, virtual]

Reimplemented from nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual long nux::ScrollView::PostLayoutManagement2 ( long  LayoutResult) [protected, virtual]
virtual void nux::ScrollView::PreLayoutManagement ( ) [protected, virtual]

Reimplemented from nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual long nux::ScrollView::ProcessEvent ( Event event,
long  TraverseInfo,
long  ProcessEventInfo 
) [protected, virtual]

Implements nux::View.

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::ResetScrollToDown ( ) [virtual]
virtual void nux::ScrollView::ResetScrollToLeft ( ) [virtual]
virtual void nux::ScrollView::ResetScrollToRight ( ) [virtual]
virtual void nux::ScrollView::ResetScrollToUp ( ) [virtual]
virtual void nux::ScrollView::ScrollDown ( float  stepy,
int  mousedy 
) [virtual]

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::ScrollLeft ( float  stepx,
int  mousedx 
) [virtual]

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::ScrollRight ( float  stepx,
int  mousedx 
) [virtual]

Reimplemented in nux::Panel, and nux::TableCtrl.

virtual void nux::ScrollView::ScrollUp ( float  stepy,
int  mousedy 
) [virtual]

Reimplemented in nux::Panel, and nux::TableCtrl.

void nux::ScrollView::setBorder ( int  border) [protected]
virtual void nux::ScrollView::SetGeometry ( const Geometry geo) [virtual]

Inherited from Area.

Reimplemented from nux::View.

Reimplemented in nux::TableCtrl.

virtual bool nux::ScrollView::SetLayout ( Layout layout) [virtual]

Set the default layout for this view.

Set the default layout for this view.

Parameters:
layoutA Layout object.

Reimplemented from nux::View.

Reimplemented in nux::Panel.

void nux::ScrollView::SetSizeMatchContent ( bool  b)

Set the table size to be such that all the content items of the table are visible . The scrollbar will be useless as the content is entirely visible all the time. If the table is empty, then it assume its minimum size. This is needed for table inside ComboBox drop down memu.

Parameters:
bIf b is true, the size of the table is constrained by its content.
See also:
IsSizeMatchLayout()
void nux::ScrollView::SetTextureIndex ( int  index) [inline, protected]

References m_TextureIndex.

void nux::ScrollView::setTopBorder ( int  top_border) [protected]
void nux::ScrollView::SetViewContentBottomMargin ( int  margin) [inline]
void nux::ScrollView::SetViewContentLeftMargin ( int  margin) [inline]
void nux::ScrollView::SetViewContentRightMargin ( int  margin) [inline]
void nux::ScrollView::SetViewContentTopMargin ( int  margin) [inline]
void nux::ScrollView::SetVScrollBar ( VScrollBar newVScrollBar) [protected]

Change Vertical Scrollbar in the ScrollView.

For styling purpose, allow the classes that inherit fron ScrollView to change the vertical scrollbar.

void nux::ScrollView::SwapTextureIndex ( ) [inline, protected]

References m_TextureIndex.


Field Documentation

int nux::ScrollView::_delta_x [protected]

Horizontal scrollbar offsets.

int nux::ScrollView::_delta_y [protected]

Vertical scrollbar offsets.

int nux::ScrollView::m_border [protected]

Height of content.

Width of content.

X Position of the content.

Y Position of the content.

Height of the scroll view content area.

Width of the scroll view content area.

X position of the scroll view content area.

Y position of the scroll view content area.

sigc::signal<void> nux::ScrollView::sigMoveWindow
sigc::signal<void, int, int, int, int> nux::ScrollView::sigResize
sigc::signal<void> nux::ScrollView::SigTest

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