SatDump 2.0.0-alpha-76a915210
Loading...
Searching...
No Matches
satdump::handlers::DummyHandler Class Reference

Dummy handler. More...

#include <dummy_handler.h>

Inheritance diagram for satdump::handlers::DummyHandler:
satdump::handlers::Handler

Public Member Functions

 DummyHandler (std::string name)
 Constructor, meant to pass the name.
void drawMenu ()
 Render explorer menu left sidebar.
void drawContents (ImVec2 win_size)
 Render explorer contents (center/left)
std::string getName ()
 Get this handler's readable name.
std::string getID ()
Public Member Functions inherited from satdump::handlers::Handler
virtual void drawMenuBar ()
 Render explorer menu bar (in the left sidebar)
virtual bool drawTreeMenu (std::shared_ptr< Handler > &h)
 Render explorer menu bar (in the left sidebar)
std::string getTreeID ()
 Get this handler's ImGui ID for rendering in the tree.
bool hasSubhandlers ()
 Check if this handler contains any sub-handlers.
virtual void addSubHandler (std::shared_ptr< Handler > handler, bool ontop=false)
 Add a new subhandler.
virtual void delSubHandler (std::shared_ptr< Handler > handler, bool now=false)
 Delete a subhandler.
virtual std::vector< std::shared_ptr< Handler > > getAllSubHandlers ()
 Get all current subhandlers.
void setCanBeSelected (bool v)
 Set if a handler can be select in the tree.
void setCanBeDragged (bool v)
 Set if a handler can be dragged around in the tree.
void setCanBeDraggedTo (bool v)
 Set if a handler can be dragged to in the tree.
void setSubHandlersCanBeDragged (bool v)
 Set if a handler's subhandlers can be dragged to in the tree.
void setCanSubBeReorgTo (bool v)
 Set if a handler's subhandlers can be reordered.
virtual void setConfig (nlohmann::json p)
 Optional, allows setting a configuration/state from JSON.
virtual nlohmann::json getConfig ()
 Optional, allows getting a configuration/state as JSON.
virtual void resetConfig ()
 Optional, allows resetting the handler's configuration.

Additional Inherited Members

Public Attributes inherited from satdump::handlers::Handler
std::string handler_tree_icon = "N"
Protected Attributes inherited from satdump::handlers::Handler
std::vector< std::shared_ptr< Handler > > subhandlers
std::mutex subhandlers_mtx

Detailed Description

Dummy handler.

This handler does absolutely nothing except exist. It is meant to simply allow storing sub-handlers in a submenu in the tree, in order to organize things when neccessary.

Constructor & Destructor Documentation

◆ DummyHandler()

satdump::handlers::DummyHandler::DummyHandler ( std::string name)
inline

Constructor, meant to pass the name.

Parameters
namethe intended readable name

Member Function Documentation

◆ drawContents()

void satdump::handlers::DummyHandler::drawContents ( ImVec2 win_size)
inlinevirtual

Render explorer contents (center/left)

Implements satdump::handlers::Handler.

◆ drawMenu()

void satdump::handlers::DummyHandler::drawMenu ( )
inlinevirtual

Render explorer menu left sidebar.

Implements satdump::handlers::Handler.

◆ getID()

std::string satdump::handlers::DummyHandler::getID ( )
inlinevirtual

◆ getName()

std::string satdump::handlers::DummyHandler::getName ( )
inlinevirtual

Get this handler's readable name.

Returns
name as a string

Reimplemented from satdump::handlers::Handler.


The documentation for this class was generated from the following file: