Program Listing for File Toggle.h

↰ Return to documentation for file (include/Karana/WebUI/Toggle.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 <functional>

namespace Karana::WebUI {
    /**
     * @brief Widget displaying a Toggle input mirroring a boolean State.
     *
     */
    class Toggle : public Widget {
      public:
        /**
         * @brief Toggle constructor
         * @param router The connection router to use
         * @param text The text displayed in the toggle, if any
         * @param on_toggle Called when the Toggle is modified
         * @param tooltip Text to display on hover
         * @param render_as_button Whether to render as an on/off slider or an up/down button
         * @param toggle_state State containing whether the toggle is on or off
         */
        Toggle(Router &router,
               std::string_view text,
               std::function<void(bool)> on_toggle,
               std::string_view tooltip = "",
               bool render_as_button = false,
               const Karana::Core::ks_ptr<State> &toggle_state = nullptr);

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

        /**
         * @brief Set the current value of the toggle
         * @param on Whether the toggle should be set to on
         */
        void setValue(bool on);

      private:
        Karana::Core::id_t _state_callback_id;
    };
} // namespace Karana::WebUI