Enum Class AssistantPageType

java.lang.Object
java.lang.Enum<AssistantPageType>
org.gnome.gtk.AssistantPageType
All Implemented Interfaces:
Serializable, Comparable<AssistantPageType>, Constable, Enumeration
@Generated("org.javagi.JavaGI") @Deprecated public enum AssistantPageType extends Enum<AssistantPageType> implements Enumeration
Deprecated.
GtkAssistant will be removed in GTK 5

Determines the role of a page inside a GtkAssistant.

The role is used to handle buttons sensitivity and visibility.

Note that an assistant needs to end its page flow with a page of type CONFIRM, SUMMARY or PROGRESS to be correct.

The Cancel button will only be shown if the page isn’t “committed”. See gtk_assistant_commit() for details.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONFIRM
    Deprecated.
    The page lets the user confirm or deny the changes.
    CONTENT
    Deprecated.
    The page has regular contents.
    CUSTOM
    Deprecated.
    Used for when other page types are not appropriate.
    INTRO
    Deprecated.
    The page contains an introduction to the assistant task.
    PROGRESS
    Deprecated.
    Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete.
    SUMMARY
    Deprecated.
    The page informs the user of the changes done.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Type
    getType()
    Deprecated.
    Get the GType of the AssistantPageType class.
    int
    getValue()
    Deprecated.
    Get the numeric value of this enum
    static AssistantPageType
    of(int value)
    Deprecated.
    Create a new AssistantPageType for the provided value
    static AssistantPageType
    of(MemorySegment address)
    Deprecated.
    Create a new AssistantPageType for the value in the provided memory address.
    static AssistantPageType
    valueOf(String name)
    Deprecated.
    Returns the enum constant of this class with the specified name.
    static AssistantPageType[]
    values()
    Deprecated.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CONTENT

      public static final AssistantPageType CONTENT
      Deprecated.
      The page has regular contents. Both the Back and forward buttons will be shown.

    • INTRO

      public static final AssistantPageType INTRO
      Deprecated.
      The page contains an introduction to the assistant task. Only the Forward button will be shown if there is a next page.

    • CONFIRM

      public static final AssistantPageType CONFIRM
      Deprecated.
      The page lets the user confirm or deny the changes. The Back and Apply buttons will be shown.

    • SUMMARY

      public static final AssistantPageType SUMMARY
      Deprecated.
      The page informs the user of the changes done. Only the Close button will be shown.

    • PROGRESS

      public static final AssistantPageType PROGRESS
      Deprecated.
      Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. Only the back button will be shown.

    • CUSTOM

      public static final AssistantPageType CUSTOM
      Deprecated.
      Used for when other page types are not appropriate. No buttons will be shown, and the application must add its own buttons through gtk_assistant_add_action_widget().

  • Method Details

    • values

      public static AssistantPageType[] values()
      Deprecated.
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AssistantPageType valueOf(String name)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • of

      public static AssistantPageType of(int value)
      Deprecated.
      Create a new AssistantPageType for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum for the provided value

    • getValue

      public int getValue()
      Deprecated.
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static AssistantPageType of(MemorySegment address)
      Deprecated.
      Create a new AssistantPageType for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Deprecated.
      Get the GType of the AssistantPageType class.
      Returns:
      the GType