ProgressBarStyler Class Reference

#include <Pt/Forms/ProgressBarStyler.h>

Binds a progress bar to the current style renderer. More...

Inherits Styler.

Public Member Functions
	ProgressBarStyler ()
	Constructs an unbound progress bar styler.
const Gfx::Brush &	background () const
	Returns the effective background brush.
void	setBackground (const Gfx::Brush &brush)
	Sets the widget-local background brush to brush.
const Gfx::Brush &	foreground () const
	Returns the effective foreground brush.
void	setForeground (const Gfx::Brush &brush)
	Sets the widget-local foreground brush to brush.
const Gfx::Pen &	contour () const
	Returns the effective contour pen.
void	setContour (const Gfx::Pen &pen)
	Sets the widget-local contour pen to pen.
const Gfx::Color &	textColor () const
	Returns the effective text color.
void	setTextColor (const Gfx::Color &color)
	Sets the widget-local text color to color.
Gfx::Font	font () const
	Returns the effective font.
void	setFont (const Gfx::Font &font)
	Sets the widget-local font to font.
void	setFontSize (std::size_t size)
	Sets the widget-local font size to size.
void	setFontWeight (Gfx::Font::Weight weight)
	Sets the widget-local font weight to weight.
void	setFontSlant (Gfx::Font::Slant slant)
	Sets the widget-local font slant to slant.
Gfx::SizeF	measureFrame (PaintSurface &surface, const Gfx::SizeF &contentSize) const
	Measures the frame enclosing contentSize.
Gfx::SizeF	measureBar (PaintSurface &surface) const
	Measures the bar's natural size.
void	layoutChrome (PaintSurface &surface, const Gfx::RectF &rect, const Gfx::SizeF &barSize, const Gfx::SizeF &textSize, Gfx::RectF &barRect, Gfx::RectF &textRect) const
	Lays out the bar and text rectangles.
void	layoutBar (PaintSurface &surface, const Gfx::RectF &barRect, float progressRatio, Gfx::RectF &trackRect, Gfx::RectF &chunkRect) const
	Lays out the track and chunk rectangles.
const Painter *	textPainter (PaintSurface &surface) const
	Returns the text painter for surface, or 0 when unavailable.
void	renderChrome (PaintContext &context, const Gfx::RectF &rect, const Gfx::RectF &trackRect, const Gfx::RectF &chunkRect, const Gfx::RectF &textRect, const String &text, const Gfx::PointF &textPos, const ProgressBarState &state) const
	Renders the chrome within rect.
void	renderBar (PaintContext &context, const Gfx::RectF &trackRect, const Gfx::RectF &chunkRect, const ProgressBarState &state) const
	Renders the bar.
void	renderTrack (PaintContext &context, const Gfx::RectF &trackRect, const ProgressBarState &state) const
	Renders the track.
void	renderChunk (PaintContext &context, const Gfx::RectF &chunkRect, const ProgressBarState &state) const
	Renders the chunk.
void	renderText (PaintContext &context, const Gfx::RectF &textRect, const Gfx::RectF &chunkRect, const String &text, const Gfx::PointF &textPos, const ProgressBarState &state) const
	Renders the text.
void	setRenderer (ProgressBarRenderer *renderer=0)
	Assigns a specific progress bar renderer.
StyleOptions &	options ()
	Returns the bound effective progress bar options.
const StyleOptions &	options () const
	Returns the bound effective progress bar options.
bool	bind (const Style &style, const StyleOptions &styleOptions)
	Binds this styler to style and styleOptions.
bool	isBound () const
	Returns true if a renderer is bound.

Protected Member Functions
virtual StyleOptions &	onBindOptions (const StyleOptions &styleOptions)
	Binds the overlay to styleOptions and returns it.
virtual Renderer *	onStyleRenderer (const Style &style)
	Returns the shared progress-bar renderer from style, or 0.
virtual Renderer *	onCreateRenderer (const Style &style)
	Creates an independent clone of the style renderer, or 0.
void	init (Renderer *renderer)
	Replaces the bound renderer with renderer.

Detailed Description

A ProgressBar owns a ProgressBarStyler. Applications do not construct one. Call Styler::bind() from onInvalidate(). When the overlay has no local options, bind uses the shared renderer from the style. Local options use a private clone. setRenderer() keeps an assigned renderer until it is cleared. A null renderer falls back on the next bind.

Appearance getters return effective tokens after bind. Setters write widget-local options. Measure, layout, and paint call the typed methods on this styler, not a public renderer accessor.

Member Function Documentation

options()

StyleOptions & options

(

)

Use StyleOptions::findLocal() to query an explicit widget-local token.

bind()

bool bind ( const Style & style, const StyleOptions & styleOptions )

inherited

Returns true when the effective renderer or the effective options changed.

init()

void init ( Renderer * renderer )

protectedinherited

A non-null renderer is a custom renderer. bind() keeps it until init() is called with 0, which falls back to the current style.