JUCE
Public Member Functions | List of all members
ScrollBar::LookAndFeelMethods Struct Referenceabstract

This abstract base class is implemented by LookAndFeel classes to provide scrollbar-drawing functionality. More...

Inheritance diagram for ScrollBar::LookAndFeelMethods:

Public Member Functions

virtual ~LookAndFeelMethods ()=default
 
virtual bool areScrollbarButtonsVisible ()=0
 
virtual void drawScrollbarButton (Graphics &g, ScrollBar &scrollbar, int width, int height, int buttonDirection, bool isScrollbarVertical, bool isMouseOverButton, bool isButtonDown)=0
 Draws one of the buttons on a scrollbar. More...
 
virtual void drawScrollbar (Graphics &g, ScrollBar &scrollbar, int x, int y, int width, int height, bool isScrollbarVertical, int thumbStartPosition, int thumbSize, bool isMouseOver, bool isMouseDown)=0
 Draws the thumb area of a scrollbar. More...
 
virtual ImageEffectFiltergetScrollbarEffect ()=0
 Returns the component effect to use for a scrollbar. More...
 
virtual int getMinimumScrollbarThumbSize (ScrollBar &)=0
 Returns the minimum length in pixels to use for a scrollbar thumb. More...
 
virtual int getDefaultScrollbarWidth ()=0
 Returns the default thickness to use for a scrollbar. More...
 
virtual int getScrollbarButtonSize (ScrollBar &)=0
 Returns the length in pixels to use for a scrollbar button. More...
 

Detailed Description

This abstract base class is implemented by LookAndFeel classes to provide scrollbar-drawing functionality.

Constructor & Destructor Documentation

◆ ~LookAndFeelMethods()

virtual ScrollBar::LookAndFeelMethods::~LookAndFeelMethods ( )
virtualdefault

Member Function Documentation

◆ areScrollbarButtonsVisible()

virtual bool ScrollBar::LookAndFeelMethods::areScrollbarButtonsVisible ( )
pure virtual

Implemented in LookAndFeel_V2, and LookAndFeel_V3.

◆ drawScrollbarButton()

virtual void ScrollBar::LookAndFeelMethods::drawScrollbarButton ( Graphics g,
ScrollBar scrollbar,
int  width,
int  height,
int  buttonDirection,
bool  isScrollbarVertical,
bool  isMouseOverButton,
bool  isButtonDown 
)
pure virtual

Draws one of the buttons on a scrollbar.

Parameters
gthe context to draw into
scrollbarthe bar itself
widththe width of the button
heightthe height of the button
buttonDirectionthe direction of the button, where 0 = up, 1 = right, 2 = down, 3 = left
isScrollbarVerticaltrue if it's a vertical bar, false if horizontal
isMouseOverButtonwhether the mouse is currently over the button (also true if it's held down)
isButtonDownwhether the mouse button's held down

Implemented in LookAndFeel_V2, and LookAndFeel_V1.

◆ drawScrollbar()

virtual void ScrollBar::LookAndFeelMethods::drawScrollbar ( Graphics g,
ScrollBar scrollbar,
int  x,
int  y,
int  width,
int  height,
bool  isScrollbarVertical,
int  thumbStartPosition,
int  thumbSize,
bool  isMouseOver,
bool  isMouseDown 
)
pure virtual

Draws the thumb area of a scrollbar.

Parameters
gthe context to draw into
scrollbarthe bar itself
xthe x position of the left edge of the thumb area to draw in
ythe y position of the top edge of the thumb area to draw in
widththe width of the thumb area to draw in
heightthe height of the thumb area to draw in
isScrollbarVerticaltrue if it's a vertical bar, false if horizontal
thumbStartPositionfor vertical bars, the y coordinate of the top of the thumb, or its x position for horizontal bars
thumbSizefor vertical bars, the height of the thumb, or its width for horizontal bars. This may be 0 if the thumb shouldn't be drawn.
isMouseOverwhether the mouse is over the thumb area, also true if the mouse is currently dragging the thumb
isMouseDownwhether the mouse is currently dragging the scrollbar

Implemented in LookAndFeel_V4, LookAndFeel_V2, LookAndFeel_V3, and LookAndFeel_V1.

◆ getScrollbarEffect()

virtual ImageEffectFilter* ScrollBar::LookAndFeelMethods::getScrollbarEffect ( )
pure virtual

Returns the component effect to use for a scrollbar.

Implemented in LookAndFeel_V2, and LookAndFeel_V1.

◆ getMinimumScrollbarThumbSize()

virtual int ScrollBar::LookAndFeelMethods::getMinimumScrollbarThumbSize ( ScrollBar )
pure virtual

Returns the minimum length in pixels to use for a scrollbar thumb.

Implemented in LookAndFeel_V2.

◆ getDefaultScrollbarWidth()

virtual int ScrollBar::LookAndFeelMethods::getDefaultScrollbarWidth ( )
pure virtual

Returns the default thickness to use for a scrollbar.

Implemented in LookAndFeel_V4, and LookAndFeel_V2.

◆ getScrollbarButtonSize()

virtual int ScrollBar::LookAndFeelMethods::getScrollbarButtonSize ( ScrollBar )
pure virtual

Returns the length in pixels to use for a scrollbar button.

Implemented in LookAndFeel_V2.


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