Class ScrollInfo

All Implemented Interfaces:
Proxy

@Generated("org.javagi.JavaGI") public class ScrollInfo extends ProxyInstance

Provides detailed information on how a scroll operation should be performed.

Scrolling functions usually allow passing a NULL scroll info which will cause the default values to be used and just scroll the element into view.

Since:
4.12
  • Constructor Details

    • ScrollInfo

      public ScrollInfo(MemorySegment address)
      Create a ScrollInfo proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object
    • ScrollInfo

      public ScrollInfo()
      Creates a new scroll info for scrolling an element into view.
      Since:
      4.12
  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the ScrollInfo class.
      Returns:
      the GType
    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout
    • getEnableHorizontal

      public boolean getEnableHorizontal()
      Checks if horizontal scrolling is enabled.
      Returns:
      true if horizontal scrolling is enabled.
      Since:
      4.12
    • getEnableVertical

      public boolean getEnableVertical()
      Checks if vertical scrolling is enabled.
      Returns:
      true if vertical scrolling is enabled.
      Since:
      4.12
    • ref

      public ScrollInfo ref()
      Increases the reference count of a GtkScrollInfo by one.
      Returns:
      the passed in GtkScrollInfo.
      Since:
      4.12
    • setEnableHorizontal

      public void setEnableHorizontal(boolean horizontal)
      Turns horizontal scrolling on or off.
      Parameters:
      horizontal - if scrolling in the horizontal direction should happen
      Since:
      4.12
    • setEnableVertical

      public void setEnableVertical(boolean vertical)
      Turns vertical scrolling on or off.
      Parameters:
      vertical - if scrolling in the vertical direction should happen
      Since:
      4.12
    • unref

      public void unref()

      Decreases the reference count of a GtkScrollInfo by one.

      If the resulting reference count is zero, frees the self.

      Since:
      4.12