class MAGES::Editor::MAGESPanelWelcomePage¶

Overview¶

A welcome page for the MAGESPanel. More…

class MAGESPanelWelcomePage: public MAGES::Editor::BaseMAGESPanelPage
{
public:
    // classes

    class TitleContent;

    // properties

    override int Order;
    override SideNavigationBarPlacement NavigationBarPlacement;
    override bool ShowBundleSelectionUI;
    override VisualElement Title;

    // methods

    virtual override void Initialize(MAGESPanel panel);
    virtual override bool TrySelect(Bundle bundle);
    virtual override void Deselect();
    virtual override VisualElement CreateGUI(Bundle selectedBundle);
};

Inherited Members¶

public:
    // enums

    enum SideNavigationBarPlacement;

    // properties

    bool Visible;
    abstract VisualElement Title;
    SideNavigationBarPlacement NavigationBarPlacement;
    int Order;
    bool ShowBundleSelectionUI;
    bool RequiresBundleSelection;

    // methods

    virtual void Initialize(MAGESPanel panel);
    virtual bool TrySelect(Bundle selectedBundle);
    virtual VisualElement CreateGUI(Bundle selectedBundle);
    virtual void Deselect();
    virtual void Destroy();
    virtual void OnSelectedBundleChanged(Bundle newSelection);

Detailed Documentation¶

A welcome page for the MAGESPanel.

Methods¶

virtual override void Initialize(MAGESPanel panel)

Called when the MAGES Panel is opened.

Parameters:

virtual override bool TrySelect(Bundle bundle)

Called when the user clicks on this page’s button in the MAGES Panel side navigation.

Parameters:

Returns:

true if the page can be selected.

virtual override void Deselect()

Called when the user selects another page in the MAGES Panel side navigation.

virtual override VisualElement CreateGUI(Bundle selectedBundle)

Called after being selected to show the page’s GUI.

Parameters:

Returns:

The Page’s GUI.