class MAGES::Editor::CollapsableTwoPaneSplitView¶

Overview¶

A split view like TwoPaneSplitView. It has a collapsable left pane, which is collapsed into a small but still visible width. More…

class CollapsableTwoPaneSplitView: public VisualElement
{
public:
    // classes

    class UxmlFactory;
    class UxmlTraits;

    // properties

    override VisualElement contentContainer;
    VisualElement FixedPane;
    VisualElement FlexedPane;
    int FixedPaneIndex;
    float FixedPaneInitialDimension;
    TwoPaneSplitViewOrientation Orientation;
    bool IsCollapsed;

    // methods

    CollapsableTwoPaneSplitView();

    CollapsableTwoPaneSplitView(
        int fixedPaneIndex,
        float fixedPaneStartDimension,
        float fixedPaneMinDimension,
        float fixedPaneCollapseDimension,
        TwoPaneSplitViewOrientation orientation
    );

    CollapsableTwoPaneSplitView(
        int fixedPaneIndex,
        float fixedPaneStartDimension,
        float fixedPaneMinDimension,
        float fixedPaneCollapseDimension,
        TwoPaneSplitViewOrientation orientation,
        System.Action onCollapseStateChanged
    );

    void CollapseChild(int index);
    void UnCollapse();
};

Detailed Documentation¶

A split view like TwoPaneSplitView. It has a collapsable left pane, which is collapsed into a small but still visible width.

Properties¶

override VisualElement contentContainer

Gets the content container.

VisualElement FixedPane

Gets the child element that is set as the fixed size pane.

VisualElement FlexedPane

Gets the child element that is set as the flexable size pane.

int FixedPaneIndex

Gets or sets 0 for setting first child as the fixed pane, 1 for the second child element.

float FixedPaneInitialDimension

Gets or sets the initial width or height for the fixed pane.

TwoPaneSplitViewOrientation Orientation

Gets or sets orientation of the split view.

bool IsCollapsed

Gets a value indicating whether the pane is collapsed.

Methods¶

CollapsableTwoPaneSplitView()

Initializes a new instance of the CollapsableTwoPaneSplitView class.

CollapsableTwoPaneSplitView(
    int fixedPaneIndex,
    float fixedPaneStartDimension,
    float fixedPaneMinDimension,
    float fixedPaneCollapseDimension,
    TwoPaneSplitViewOrientation orientation
)

Initializes a new instance of the CollapsableTwoPaneSplitView class. Parameterized constructor.

Parameters:

CollapsableTwoPaneSplitView(
    int fixedPaneIndex,
    float fixedPaneStartDimension,
    float fixedPaneMinDimension,
    float fixedPaneCollapseDimension,
    TwoPaneSplitViewOrientation orientation,
    System.Action onCollapseStateChanged
)

Initializes a new instance of the CollapsableTwoPaneSplitView class.

Parameters:

void CollapseChild(int index)

Collapses a child.

Parameters:

void UnCollapse()

Uncollapses.