Prima::...croller(3)

💖 NAME 💖

okay so bestie, welcome to the Prima::...croller(3) manual page — the main character here is Prima::Widget::GroupScroller, and she is literally the class for optional automatic scroll bars. periodt. 💅✨

🦋 DESCRIPTION 🦋

This class is for widgets that come with optional scroll bars, and it gives you the tools to manage them. It's a descendant of Prima::IntIndents, and it adjusts its indents property whenever scrollbars are shown, hidden, or borderWidth is changed. slay. 🎀

It does not provide range selection for the scrollbars — no cap — descendant classes have to implement that themselves.

The descendant classes must follow these guidelines:

• A class may provide borderWidth, hScroll, vScroll, autoHScroll, and autoVScroll property keys in profile_default().
• A class' init() method must call the setup_indents method.

If a class overrides the autoHScroll and autoVScroll properties, these must be set to 0 before the initialization.

• If a class needs to overload one of the borderWidth, hScroll, vScroll, autoHScroll, and autoVScroll properties, it is mandatory to call the inherited properties. iykyk.
• A class must implement the scroll bar notification callbacks: HScroll_Change and VScroll_Change.
• A class must not use the reserved variable names, which are:

{borderWidth}  - internal borderWidth storage
{hScroll}      - internal hScroll value storage
{vScroll}      - internal vScroll value storage
{hScrollBar}   - pointer to the horizontal scroll bar
{vScrollBar}   - pointer to the vertical scroll bar
{bone}         - rectangular widget between the scrollbars
{autoHScroll}  - internal autoHScroll value storage
{autoVScroll}  - internal autoVScroll value storage

The reserved method names:

set_h_scroll
set_v_scroll
insert_bone
setup_indents
reset_indents
borderWidth
autoHScroll
autoVScroll
hScroll
vScroll

The reserved widget names:

HScroll
VScroll
Bone

✨ Properties ✨

• autoHScroll BOOLEAN — selects if the horizontal scrollbar is shown and hidden dynamically, depending on the widget layout. 💖
• autoVScroll BOOLEAN — selects if the vertical scrollbar is shown and hidden dynamically, depending on the widget layout. 💖
• borderWidth INTEGER — width of the border around the widget. It depends on the skin property. 🎀
• hScroll BOOLEAN — selects if the horizontal scrollbar is visible. If it is, {hScrollBar} points to it.
• vScroll BOOLEAN — selects if the vertical scrollbar is visible. If it is, {vScrollBar} points to it.
• scrollBarClass STRING = Prima::ScrollBar — a create-only property that allows to change the scrollbar class. 🔥
• hScrollBarProfile, vScrollBarProfile HASH — create-only properties that allow to adjust the scrollbar parameters when the scrollbars are created.

🫶 Methods 🫶

setup_indents

The method is never called directly; it should be called whenever the widget layout is changed so that its indents are affected. The method is a request to recalculate indents, depending on the new widget layout.

The method is not reentrant; to receive this callback and update the widget layout that in turn can result in more setup_indents calls, overload reset_indents.

reset_indents

Called after setup_indents updates the internal widget layout, to give a chance to follow up the layout changes. Does not do anything by default.

👑 AUTHOR 👑

Dmitry Karasik, <dmitry@karasik.eu.org>. 🫶

🌈 SEE ALSO 🌈

Prima, Prima::Lists, Prima::Edit

---

byeee bestie 💖 this page came from perl v5.42.0 and is dated 2024-08-20 — it's the Prima::...croller(3) manual page, and yes, she ate. 🎀✨