sincerely Singaporean

If you have not done so, read this full tutorial on how to use SGEXTN to build an application.

SGWScrollView

see header file

see source file

class SGWScrollView;

part of SGEXTN module SG_Widgets

SGWidget ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ scroll view

detailed description

list of all including inherited members

implementation details

preprocessor file inclusion directive: #include ‹SGWScrollView.h›

CMake target for BuildLah: SGEXTN::SG_Widgets

see this link for more information about BuildLah

parent class: SGWBackground

children classes: (none)

instance member functions

SGWScrollView(SGWWidget* parent, float x1, float x0, float y1, float y0, float w1, float w0, float h1, float h0, float i1, float i0, float s1, float s0);

[[nodiscard]] float getI0() const;

[[nodiscard]] float getI1() const;

[[nodiscard]] float getS0() const;

[[nodiscard]] float getS1() const;

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundColour(bool* isUsing) const;

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundFocusColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarBackgroundFocusThemeColour(bool* isUsing) const;

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundHoverColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarBackgroundHoverThemeColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarBackgroundThemeColour(bool* isUsing) const;

[[nodiscard]] SGXColourRGBA getScrollbarForegroundColour(bool* isUsing) const;

[[nodiscard]] SGXColourRGBA getScrollbarForegroundFocusColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarForegroundFocusThemeColour(bool* isUsing) const;

[[nodiscard]] SGXColourRGBA getScrollbarForegroundHoverColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarForegroundHoverThemeColour(bool* isUsing) const;

[[nodiscard]] int getScrollbarForegroundThemeColour(bool* isUsing) const;

void setI0(float i0);

void setI1(float i1);

void setS0(float s0);

void setS1(float s1);

void setScrollbarBackgroundColour(SGXColourRGBA colour);

void setScrollbarBackgroundFocusColour(SGXColourRGBA colour);

void setScrollbarBackgroundFocusThemeColour(int themeColour);

void setScrollbarBackgroundHoverColour(SGXColourRGBA colour);

void setScrollbarBackgroundHoverThemeColour(int themeColour);

void setScrollbarBackgroundThemeColour(int themeColour);

void setScrollbarForegroundColour(SGXColourRGBA colour);

void setScrollbarForegroundFocusColour(SGXColourRGBA colour);

void setScrollbarForegroundFocusThemeColour(int themeColour);

void setScrollbarForegroundHoverColour(SGXColourRGBA colour);

void setScrollbarForegroundHoverThemeColour(int themeColour);

void setScrollbarForegroundThemeColour(int themeColour);

Detailed Description

SGWScrollView provides a scroll view that contains SGWidget ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ UI elements. Unlike SGWSequentialScrollView, this fully supports w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ and should be used unless you want SGWSequentialLongLabel components. Note that the available space in a SGWScrollView is fixed.

Implementation Details

Stores information about the SGWScrollView.

SGWScrollView(SGWWidget* parent, float x1, float x0, float y1, float y0, float w1, float w0, float h1, float h0, float i1, float i0, float s1, float s0);

Creates a SGWScrollView with parent SGWidget ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ parent and w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ coordinates (x1, x0, y1, y0, w1, w0, h1, h0). Additionally, the scrollbar width as a w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ is (s1, s0) and the available space inside the SGWScrollView as a w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ is (i1, i0).

parent being nullptr is undefined behaviour.

To avoid use after free bugs, deleting a SGWBackground directly will cause a crash. Use SGWBackground::disable or SGWWidget::deleteWidget to delete it safely.

[[nodiscard]] float getI0() const;

Returns the 0 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ representation of the available space.

[[nodiscard]] float getI1() const;

Returns the 1 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ representation of the available space.

[[nodiscard]] float getS0() const;

Returns the 0 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ controlling the scrollbar width.

[[nodiscard]] float getS1() const;

Returns the 1 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ controlling the scrollbar width.

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar background of this SGWLongLabel. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundFocusColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar background of this SGWLongLabel when focused. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarBackgroundFocusThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar background of this SGWLongLabel when focused. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] SGXColourRGBA getScrollbarBackgroundHoverColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar background of this SGWLongLabel when hovered over. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarBackgroundHoverThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar background of this SGWLongLabel when hovered over. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarBackgroundThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar background of this SGWLongLabel. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] SGXColourRGBA getScrollbarForegroundColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar foreground of this SGWLongLabel. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] SGXColourRGBA getScrollbarForegroundFocusColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar foreground of this SGWLongLabel when focused. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarForegroundFocusThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar foreground of this SGWLongLabel when focused. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] SGXColourRGBA getScrollbarForegroundHoverColour(bool* isUsing) const;

Returns the SGXColourRGBA currently being used for the scrollbar foreground of this SGWLongLabel when hovered over. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is off, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarForegroundHoverThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar foreground of this SGWLongLabel when hovered over. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

[[nodiscard]] int getScrollbarForegroundThemeColour(bool* isUsing) const;

Returns the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ currently being used for the scrollbar foreground of this SGWLongLabel. The bool that isUsing points to is set to true if theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode is on, and false otherwise.

If you are not interested in the current theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode, pass nullptr to isUsing.

void setI0(float i0);

Sets the 0 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ representation of the available space to i0.

void setI1(float i1);

Sets the 1 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ representation of the available space to i1.

void setS0(float s0);

Sets the 0 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ controlling the scrollbar width to s0.

void setS1(float s1);

Sets the 1 coordinate of the w-distance ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ controlling the scrollbar width to s1.

void setScrollbarBackgroundColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar background of this SGWLongLabel to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarBackgroundFocusColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar background of this SGWLongLabel when focused to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarBackgroundFocusThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar background of this SGWLongLabel when focused to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarBackgroundHoverColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar background of this SGWLongLabel when hovered over to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarBackgroundHoverThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar background of this SGWLongLabel when hovered over to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarBackgroundThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar background of this SGWLongLabel to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar foreground of this SGWLongLabel to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundFocusColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar foreground of this SGWLongLabel when focused to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundFocusThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar foreground of this SGWLongLabel when focused to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundHoverColour(SGXColourRGBA colour);

Sets the SGXColourRGBA of the scrollbar foreground of this SGWLongLabel when hovered over to colour and turns off theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundHoverThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar foreground of this SGWLongLabel when hovered over to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

void setScrollbarForegroundThemeColour(int themeColour);

Sets the theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ of the scrollbar foreground of this SGWLongLabel to themeColour and turns on theme colour ⁽㈳㈴㈳㈮㈱㈨㈠㈫ ㈧㈤㈱㈤⁾ mode.

©2025 05524F.sg (Singapore)

contact 05524F / report a bug / make a suggestion

about 05524F SINGAPORE values

list of 05524F projects