Program Listing for File TreeView.h

↰ Return to documentation for file (include/Karana/WebUI/TreeView.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/KCore/Id.h"
#include "Karana/WebUI/Router.h"
#include "Karana/WebUI/Selection.h"
#include "Karana/WebUI/State.h"
#include "Karana/WebUI/Widget.h"
#include <functional>
#include <memory>
#include <optional>
#include <vector>

namespace Karana::WebUI {
    /**
     * @brief Widget displaying an interactable tree using hierarchical html
     *
     * Although the class is named TreeView, general acyclic graphs are
     * supported. In this case a Node and its descendants will appear under
     * each of its parents.
     *
     */
    class TreeView : public Widget {
      public:
        /**
         * @brief Data for a node in a TreeView
         */
        struct Node {
            /// Id of an object to associate the node with
            Karana::Core::id_t id;
            /// Display name of the node
            std::string label = "unnamed";
            /// Extra css class to apply to the node on the frontend
            std::string style_class = "";
            /// Optional tooltip text
            std::string tooltip = "";
            /// Whether the node should start collapsed
            bool collapsed = false;
        };

        /**
         * @struct Edge
         * @brief Data for an edge in a TreeView
         */
        struct Edge {
            /// Id of the parent node
            Karana::Core::id_t parent_id;

            /// Id of the child node
            Karana::Core::id_t child_id;
        };

        /// Alias for a list of nodes
        using NodeList = std::vector<Node>;

        /// Alias for a list of edges
        using EdgeList = std::vector<Edge>;

        /**
         * @brief TreeView constructor
         *
         * @param router The connection router to use
         * @param nodes The initial list of nodes in the tree
         * @param edges The initial list of edges in the tree
         * @param on_select Called when a node is selected in the UI
         * @param on_refresh Called when a node is refreshed in the UI
         * @param selection Optional existing State for the selection
         */
        TreeView(Router &router,
                 const NodeList &nodes = {},
                 const EdgeList &edges = {},
                 std::function<void(const Selection &)> on_select = {},
                 std::function<void()> on_refresh = {},
                 const Karana::Core::ks_ptr<State> &selection = nullptr);

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

        /**
         * @brief Select the given items
         *
         * Note that calling this does not invoke the on_select callback
         * passed into the constructor
         *
         * @param selection The new Selection
         */
        void select(const Selection &selection = Selection{});

        /**
         * @brief Update the label for the node with the given id.
         * @param id The node id.
         * @param label The new label text for the node.
         */
        void setNodeLabel(Karana::Core::id_t id, std::string_view label);

        /**
         * @brief Use a new set of nodes.
         * @param nodes The new list of nodes.
         * @param edges The new list of edges.
         */
        void setTree(const NodeList &nodes, const EdgeList &edges);

        /**
         * @brief Forces a refresh of the TreeView via its `on_refresh()` callback, if any was set.
         *
         * Do not call this from the `on_refresh` callback itself, since that would create a cycle.
         *
         */
        void refresh() const;

      protected:
        /**
         * @brief First setup on initial connection
         *
         * @param client_id The ID of the client connecting.
         */
        virtual void _onConnect(int client_id) override;

        /**
         * @brief Used to handle refresh messages
         *
         * @param message The refresh message.
         * @param client_id The ID of the client to refresh.
         */
        virtual void _onMessage(std::string_view message, int client_id) override;

      private:
        std::unique_ptr<struct TreeViewImpl> _impl;

        /// Function pointer to execute on refresh; we expect this to call setTree internally
        std::function<void()> _on_refresh;
    };
} // namespace Karana::WebUI