shell_view.h

Go to the documentation of this file.

 
#pragma once
 
// standard includes
#include <cstddef>
#include <string>
#include <vector>
 
// local includes
#include "src/app/client_state.h"
#include "src/logging/logger.h"
 
namespace ui {
 
  struct ShellToolbarButton {
    std::string id;  
    std::string label;  
    std::string glyph;  
    std::string iconAssetPath;  
    bool selected = false;  
  };
 
  struct ShellHostTile {
    std::string id;  
    std::string displayName;  
    std::string statusLabel;  
    std::string iconAssetPath;  
    app::PairingState pairingState = app::PairingState::not_paired;  
    app::HostReachability reachability = app::HostReachability::unknown;  
    bool selected = false;  
  };
 
  struct ShellAppTile {
    std::string id;  
    std::string name;  
    std::string detail;  
    std::string badgeLabel;  
    std::string boxArtCacheKey;  
    bool hidden = false;  
    bool favorite = false;  
    bool boxArtCached = false;  
    bool running = false;  
    bool selected = false;  
  };
 
  struct ShellActionRow {
    std::string id;  
    std::string label;  
    bool enabled = true;  
    bool selected = false;  
    bool checked = false;  
  };
 
  struct ShellFooterAction {
    std::string id;  
    std::string label;  
    std::string iconAssetPath;  
    std::string secondaryIconAssetPath;  
    bool emphasized = false;  
  };
 
  struct ShellNotification {
    std::string title;  
    std::string message;  
    std::vector<ShellFooterAction> actions;  
  };
 
  struct ShellModalButton {
    std::string label;  
    bool enabled = true;  
    bool selected = false;  
  };
 
  struct ShellFrameView {
    app::ScreenId screen = app::ScreenId::hosts;  
    std::string title;  
    std::string pageTitle;  
    std::string statusMessage;  
    std::vector<ShellFooterAction> footerActions;  
  };
 
  struct ShellPageContentView {
    std::vector<ShellToolbarButton> toolbarButtons;  
    std::vector<ShellHostTile> hostTiles;  
    std::size_t hostColumnCount = 3U;  
    std::vector<ShellAppTile> appTiles;  
    std::size_t appColumnCount = 4U;  
    std::vector<std::string> bodyLines;  
    std::vector<ShellActionRow> menuRows;  
    std::vector<ShellActionRow> detailMenuRows;  
    std::string selectedMenuRowLabel;  
    std::string selectedMenuRowDescription;  
    bool leftPanelActive = false;  
    bool rightPanelActive = false;  
  };
 
  struct ShellNotificationView {
    bool visible = false;  
    ShellNotification content;  
  };
 
  struct ShellOverlayView {
    bool visible = false;  
    std::string title;  
    std::vector<std::string> lines;  
  };
 
  struct ShellModalView {
    bool visible = false;  
    std::string title;  
    std::vector<std::string> lines;  
    std::vector<ShellActionRow> actions;  
    std::vector<ShellFooterAction> footerActions;  
  };
 
  struct ShellLogViewerView {
    bool visible = false;  
    std::string path;  
    std::vector<std::string> lines;  
    std::size_t scrollOffset = 0U;  
    app::LogViewerPlacement placement = app::LogViewerPlacement::full;  
  };
 
  struct ShellKeypadModalView {
    bool visible = false;  
    std::string title;  
    std::vector<std::string> lines;  
    std::vector<ShellModalButton> buttons;  
    std::size_t columnCount = 0U;  
  };
 
  struct ShellViewModel {
    ShellFrameView frame;  
    ShellNotificationView notification;  
    ShellPageContentView content;  
    ShellOverlayView overlay;  
    ShellModalView modal;  
    ShellLogViewerView logViewer;  
    ShellKeypadModalView keypad;  
  };
 
  ShellViewModel build_shell_view_model(
    const app::ClientState &state,
    const std::vector<logging::LogEntry> &logEntries,
    const std::vector<std::string> &statsLines = {}
  );
 
}  // namespace ui