MainBar.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2017 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

namespace ILIAS\UI\Component\MainControls;

use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\Button;
use ILIAS\UI\Component\MainControls\Slate;
use ILIAS\UI\Component\JavaScriptBindable;

interface MainBar extends \ILIAS\UI\Component\Component, JavaScriptBindable
{
    public function withAdditionalEntry(string $id, $entry) : MainBar;

    public function getEntries() : array;

    public function withAdditionalToolEntry(
        string $id,
        Slate\Slate $entry,
        bool $initially_hidden = false,
        Button\Close $close_button = null
    ) : MainBar;

    public function getToolEntries();

    public function withActive(string $active) : MainBar;

    public function getActive();

    public function withToolsButton(Button\Bulky $button) : MainBar;

    public function getToolsButton() : Button\Bulky;

    public function withMoreButton(Button\Bulky $button) : MainBar;

    public function getMoreButton() : Button\Bulky;

    public function getEntryClickSignal() : Signal;

    public function getToolsClickSignal() : Signal;

    public function getToolsRemovalSignal() : Signal;

    public function getDisengageAllSignal() : Signal;

    public function getInitiallyHiddenToolIds() : array;

    public function getEngageToolSignal(string $tool_id) : Signal;

    public function getCloseButtons() : array;

    public function withClearedEntries() : MainBar;

    public function getToggleToolsSignal() : Signal;
}