ScrollAreaGadget3D()

Syntax

Result = ScrollAreaGadget3D(#Gadget3D, x, y, Width, Height, ScrollAreaWidth, ScrollAreaHeight, ScrollStep)
Description
Creates a ScrollArea gadget in the current GadgetList. If #PB_Any is used as '#Gadget3D' parameter, the new gadget number will be returned as 'Result'. It's very useful when a gadget is too big to fit the window dimension. In that case, it can be put into a scrollarea. All the scrolling is handled automatically by the gadget. This is a container gadget, intended to have one or several gadget in its scroll area. Once the gadget is created, all future created gadgets will be created inside the scroll area. When all the needed gadgets have been created, CloseGadgetList3D() must be called to return to the previous GadgetList. OpenGadgetList3D() can be used later to add others gadgets on the fly in the scroll area.

'ScrollAreaWidth' and 'ScrollAreaHeight' are the initial dimensions of the scrollable area contained inside the gadget and should be greater than the gadget's 'Width' and 'Height' dimensions. 'ScrollStep' is the number of pixels scrolled when pressing a slider arrow. #Gadget3D will be the number returned by EventGadget3D() function. When the user moves the scrollbars in the gadget, an event will be received for the gadget.

The following functions can be used to act on a ScrollAreaGadget:

GetGadgetAttribute3D(): With one of the following attribute:
  #PB_ScrollArea3D_InnerWidth  : Returns the width (in pixels) of the contained scrollable area.
  #PB_ScrollArea3D_InnerHeight : Returns the height (in pixels) of the contained scrollable area.
  #PB_ScrollArea3D_X           : Returns the current horizontal scrolling position (in pixels).
  #PB_ScrollArea3D_Y           : Returns the current vertical scrolling position (in pixels).
SetGadgetAttribute3D(): With one of the following attribute:
  #PB_ScrollArea3D_InnerWidth  : Changes the width (in pixels) of the contained scrollable area.
  #PB_ScrollArea3D_InnerHeight : Changes the height (in pixels) of the contained scrollable area.
  #PB_ScrollArea3D_X           : Changes the current horizontal scrolling position (in pixels).
  #PB_ScrollArea3D_Y           : Changes the current vertical scrolling position (in pixels).

Supported OS

All

<- ResizeGadget3D() - Gadget3D Index - ScrollBarGadget3D() ->