class MAGES::Editor::BaseMAGESPanelPage¶

Overview¶

A Page for the MAGES Panel. More…

class BaseMAGESPanelPage
{
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);
};

// direct descendants

class MAGESAnalyticsEditor;
class MAGESPanelConfigurationPage;
class MAGESPanelDevicesPage;
class MAGESPanelHubPage;
class MAGESPanelLoginPage;
class MAGESPanelWelcomePage;
class JARIAPane;
class MAGESPanelScenegraphPage;

Detailed Documentation¶

A Page for the MAGES Panel.

Properties¶

bool Visible

Gets a value indicating whether the page is visible in the side navigation bar.

abstract VisualElement Title

Gets the title to show in the MAGES Panel side navigation.

SideNavigationBarPlacement NavigationBarPlacement

Gets or sets where to position the page in the MAGES Panel side navigation.

int Order

Gets the order with which to show this page in the MAGES Panel side navigation.

bool ShowBundleSelectionUI

Gets a value indicating whether or not to show the bundle selection UI in the MAGES Panel.

bool RequiresBundleSelection

Gets a value indicating whether this page requires a bundle to be displayed. If no bundle is selected a page informing the user to select a bundle will be shown and the CreateGUI method will not be called. Once a bundle is selected the CreateGUI method will be called, immediately after the OnSelectedBundleChanged(Bundle).

Methods¶

virtual void Initialize(MAGESPanel panel)

Called when the MAGES Panel is opened.

Parameters:

virtual bool TrySelect(Bundle selectedBundle)

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 VisualElement CreateGUI(Bundle selectedBundle)

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

Parameters:

Returns:

The Page’s GUI.

virtual void Deselect()

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

virtual void Destroy()

Called when the panel is destroyed.

virtual void OnSelectedBundleChanged(Bundle newSelection)

Called when the user selects a new Bundle in the MAGES Panel.

Parameters: