Class MaetermAPI

Index Home MAE > MAE Architecture > MAE Data Types > Class Index > Class MaetermAPI

Summary
Public Methods
static bool key(device, key, keycode)
static bool redraw(device)
static bool send(request, params)

#include <MaetermAPI.h >

Summary

This class is used by other apps to send messages to the maeterm channel.

Use this interface instead of sending messages directly to ensure message keywords are spelled correctly, all parameters are specified, and error checked.

The receiving app defined this interface to ensure it receives the messages correctly.

Public Methods

static bool key(device, key, keycode)

const UserDevice& device

end-user's device

const string& key

single keystroke, either the character or special keystroke name

int keycode

the printable ASCII code of the key, if defined


Relay user keystroke to a specific MaeTerm instance's application.

static bool redraw(device)

const UserDevice& device

end-user's device


Request a redraw.

Return value: true if sent

static bool send(request, params)

const string& request

the request keyword

const XMLData& params

the data (parameter payload)

Default value: XMLData("")


Send an API message to channel maeterm.