Description

Actual definition of Steam-Layer command scripts for meta/ctrl actions.

Any actions issued by the UI-Layer to control internal application state

Todo:: WIP 8/2018 early draft

See also: cmd.hpp; command.hpp; command-def.hpp; cmd-context.hpp; SessionCommandFunction_test

Definition in file meta-cmd.cpp.

#include "steam/cmd.hpp"
#include "steam/control/command-def.hpp"
#include "include/ui-protocol.hpp"
#include "include/gui-notification-facade.h"
#include "stage/interact/wizard.hpp"
#include "lib/diff/gen-node.hpp"
#include "lib/idi/entry-id.hpp"
#include "lib/format-string.hpp"
#include "lib/util.hpp"
#include <string>

Functions
	COMMAND_DEFINITION (test_meta_activateContentDiff)
	instruct the session to start keeping the UI up-to-date through diff messages. More...

	COMMAND_DEFINITION (meta_deactivateContentDiff)
	instruct the session to start keeping the UI up-to-date through diff messages. More...

	COMMAND_DEFINITION (test_meta_displayInfo)
	DemoGuiRoundtrip: push a notification info message back up into the UI. More...

	COMMAND_DEFINITION (test_meta_markError)
	DemoGuiRoundtrip: send a `markError` message back up into the UI. More...

	COMMAND_DEFINITION (test_meta_markNote)
	DemoGuiRoundtrip: send a `markNote` message back up into the UI. More...

	COMMAND_DEFINITION (test_meta_markAction)
	DemoGuiRoundtrip: send a generic `mark` message with given action ID back up into the UI. More...

Namespaces
	steam
	Steam-Layer implementation namespace root.

Function Documentation

◆ COMMAND_DEFINITION() [1/6]

steam::cmd::COMMAND_DEFINITION ( test_meta_activateContentDiff )

instruct the session to start keeping the UI up-to-date through diff messages.

Remarks: we assume the UI is empty when issuing this command. Thus the session will commence by sending a population diff, to reflect all the UI relevant structures currently present within the session data. Moreover, from that point on, any changes within the session structure and contents will be reflected by pushing appropriate diff messages upwards through the GuiNotification façade.

Note: to UNDO this action means to waive the live-update state. In addition, the session will push up a status change to mark the session-root as defunct.

Todo:: used for preliminary integration testing ///////////////////////////////////////////TICKET #211 prefix test_ bypasses logging and immediately executes for now (2018)

Definition at line 80 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [2/6]

steam::cmd::COMMAND_DEFINITION ( meta_deactivateContentDiff )

instruct the session to start keeping the UI up-to-date through diff messages.

Remarks: we assume the UI is empty when issuing this command. Thus the session will commence by sending a population diff, to reflect all the UI relevant structures currently present within the session data. Moreover, from that point on, any changes within the session structure and contents will be reflected by pushing appropriate diff messages upwards through the GuiNotification façade.

Note: to UNDO this action means to waive the live-update state. In addition, the session will push up a status change to mark the session-root as defunct.

Definition at line 113 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [3/6]

steam::cmd::COMMAND_DEFINITION ( test_meta_displayInfo )

DemoGuiRoundtrip: push a notification info message back up into the UI.

Todo:: this is a demo mock setup to further development of the Steam-Stage integration //////////////TICKET #1140 : prototypical Steam-Stage communication

Definition at line 142 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [4/6]

steam::cmd::COMMAND_DEFINITION ( test_meta_markError )

DemoGuiRoundtrip: send a markError message back up into the UI.

Todo:: this is a demo mock setup to further development of the Steam-Stage integration //////////////TICKET #1140 : prototypical Steam-Stage communication

Definition at line 162 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [5/6]

steam::cmd::COMMAND_DEFINITION ( test_meta_markNote )

DemoGuiRoundtrip: send a markNote message back up into the UI.

Todo:: this is a demo mock setup to further development of the Steam-Stage integration //////////////TICKET #1140 : prototypical Steam-Stage communication

Definition at line 183 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [6/6]

steam::cmd::COMMAND_DEFINITION ( test_meta_markAction )

DemoGuiRoundtrip: send a generic mark message with given action ID back up into the UI.

Todo:: this is a demo mock setup to further development of the Steam-Stage integration //////////////TICKET #1140 : prototypical Steam-Stage communication

Definition at line 204 of file meta-cmd.cpp.