Program Listing for File Dock.h

↰ Return to documentation for file (include/Karana/WebUI/Dock.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

#pragma once

#include "Karana/WebUI/Router.h"
#include "Karana/WebUI/Widget.h"
#include <memory>
#include <optional>

namespace Karana::WebUI {
    /**
     * @class Dock
     * @brief Widget container allow repositioning of children on the frontend
     */
    class Dock {
      public:
        /**
         * @brief Dock constructor
         * @param router Used to establish the frontend connection
         */
        Dock(Router &router);

        /**
         * @brief Dock destructor
         */
        virtual ~Dock();

        /**
         * @brief Add a widget as a panel in the dock layout
         * @param title The title to display on the widget's panel
         * @param widget The widget to add
         */
        void addChild(std::string_view title, const Widget &widget);

        /**
         * @brief Add a widget as a panel in the dock layout
         * @param title The title to display on the widget's panel
         * @param widget The widget to add
         * @param relative_to Another widget to position relative to
         * @param direction One of left, right, above, below, or within
         */
        void addChild(std::string_view title,
                      const Widget &widget,
                      const Widget &relative_to,
                      std::string_view direction = {});

      private:
        std::unique_ptr<struct DockState> _state;
    };
} // namespace Karana::WebUI