OverlayScrollBar Class Reference

A custom scroll bar with overlay images for packet representation. More...

#include <overlay_scroll_bar.h>

Inheritance diagram for OverlayScrollBar:

Public Slots
void	setChildRange (int min, int max)
	Sets the range of the child scroll bar.

Public Member Functions
	OverlayScrollBar (Qt::Orientation orientation, QWidget *parent=0)
	Constructs a new OverlayScrollBar.
virtual	~OverlayScrollBar ()
	Destroys the OverlayScrollBar.
virtual QSize	sizeHint () const
	Returns the recommended size for the scroll bar.
virtual int	sliderPosition ()
	Retrieves the current slider position.
void	setNearOverlayImage (QImage &overlay_image, int packet_count=-1, int start_pos=-1, int end_pos=-1, QList< int > positions=QList< int >(), int rowHeight=1)
	Set the "near" overlay image.
void	setMarkedPacketImage (QImage &mp_image)
	Set the "far" overlay image.
QRect	grooveRect ()
	Retrieves the "groove" area of the child scrollbar.

Protected Member Functions
virtual void	resizeEvent (QResizeEvent *event)
	Handles resize events.
virtual void	paintEvent (QPaintEvent *event)
	Handles paint events.
virtual bool	eventFilter (QObject *watched, QEvent *event)
	Filters events for watched objects.
virtual void	mousePressEvent (QMouseEvent *)
	Handles mouse press events (no-op).
virtual void	mouseReleaseEvent (QMouseEvent *event)
	Handles mouse release events.

Detailed Description

A custom scroll bar with overlay images for packet representation.

Constructor & Destructor Documentation

OverlayScrollBar()

OverlayScrollBar::OverlayScrollBar	(	Qt::Orientation	orientation,
		QWidget *	parent = 0
	)

Constructs a new OverlayScrollBar.

Parameters

orientation	The scroll bar orientation.
parent	The parent widget, defaults to 0.

Member Function Documentation

eventFilter()

bool OverlayScrollBar::eventFilter ( QObject *  watched, QEvent *  event  )

protectedvirtual

Filters events for watched objects.

Parameters

watched	The watched object.
event	The event to filter.

Returns

True if the event was filtered, false otherwise.

grooveRect()

QRect OverlayScrollBar::grooveRect

(

)

Retrieves the "groove" area of the child scrollbar.

Returns

The rectangle defining the groove area.

mouseReleaseEvent()

void OverlayScrollBar::mouseReleaseEvent ( QMouseEvent *  event )

protectedvirtual

Handles mouse release events.

Parameters

event

The mouse release event.

paintEvent()

void OverlayScrollBar::paintEvent ( QPaintEvent *  event )

protectedvirtual

Handles paint events.

Parameters

event

The paint event.

resizeEvent()

void OverlayScrollBar::resizeEvent ( QResizeEvent *  event )

protectedvirtual

Handles resize events.

Parameters

event

The resize event.

setChildRange

void OverlayScrollBar::setChildRange ( int  min, int  max  )

inlineslot

Sets the range of the child scroll bar.

Parameters

min	The minimum value.
max	The maximum value.

setMarkedPacketImage()

void OverlayScrollBar::setMarkedPacketImage

(

QImage &

mp_image

)

Set the "far" overlay image.

Parameters

mp_image

An image showing the position of marked, ignored, and reference time packets over the entire packet list. It should be sized in device pixels.

setNearOverlayImage()

void OverlayScrollBar::setNearOverlayImage	(	QImage &	overlay_image,
		int	packet_count = -1,
		int	start_pos = -1,
		int	end_pos = -1,
		QList< int >	positions = QList<int>(),
		int	rowHeight = 1
	)

Set the "near" overlay image.

Parameters

overlay_image	An image containing a 1:1 mapping of nearby packet colors to raster lines. It should be sized in device pixels.
packet_count	Number of packets.
start_pos	The first packet number represented by the image. -1 means no packet is selected.
end_pos	The last packet number represented by the image. -1 means no packet is selected.
positions	The positions of the selected packets within the image.
rowHeight	The row height to be used for displaying the mark

sizeHint()

QSize OverlayScrollBar::sizeHint ( ) const

virtual

Returns the recommended size for the scroll bar.

Returns

The size hint as a QSize.

sliderPosition()

int OverlayScrollBar::sliderPosition ( )

virtual

Retrieves the current slider position.

Returns

The slider position.

---

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

• /builds/wireshark/wireshark/ui/qt/widgets/overlay_scroll_bar.h
• /builds/wireshark/wireshark/ui/qt/widgets/overlay_scroll_bar.cpp