sk_app::CommandSet Class Reference

#include <CommandSet.h>

Public Member Functions
	CommandSet ()
void	attach (Window *window)
bool	onKey (skui::Key key, skui::InputState state, skui::ModifierKey modifiers)
bool	onChar (SkUnichar, skui::ModifierKey modifiers)
bool	onSoftkey (const SkString &softkey)
void	addCommand (SkUnichar c, const char *group, const char *description, std::function< void(void)> function)
void	addCommand (skui::Key k, const char *keyName, const char *group, const char *description, std::function< void(void)> function)
void	drawHelp (SkCanvas *canvas)
std::vector< SkString >	getCommandsAsSoftkeys () const

Detailed Description

Helper class used by applications that want to hook keypresses to trigger events.

An app can simply store an instance of CommandSet and then use it as follows: 1) Attach to the Window at initialization time. 2) Register commands to be executed for characters or keys. Each command needs a Group and a description (both just strings). Commands attached to Keys (rather than characters) also need a displayable name for the Key. Finally, a function to execute when the key or character is pressed must be supplied. The easiest option to is pass in a lambda that captures [this] (your application object), and performs whatever action is desired. 3) Register key and char handlers with the Window, and - depending on your state - forward those events to the CommandSet's onKey, onChar, and onSoftKey. 4) At the end of your onPaint, call drawHelp, and pass in the application's canvas.

The CommandSet always binds 'h' to cycle through two different help screens. The first shows all commands, organized by Group (with headings for each Group). The second shows all commands alphabetically by key/character.

Definition at line 44 of file CommandSet.h.

Constructor & Destructor Documentation

CommandSet()

sk_app::CommandSet::CommandSet

(

)

Definition at line 23 of file CommandSet.cpp.

    : fHelpMode(kNone_HelpMode) {
    this->addCommand('h', "Overlays", "Show help screen", [this]() {
        switch (this->fHelpMode) {
            case kNone_HelpMode:
                this->fHelpMode = kGrouped_HelpMode;
                break;
            case kGrouped_HelpMode:
                this->fHelpMode = kAlphabetical_HelpMode;
                break;
            case kAlphabetical_HelpMode:
                this->fHelpMode = kNone_HelpMode;
                break;
        }
        fWindow->inval();
    });
}

Member Function Documentation

addCommand() [1/2]

void sk_app::CommandSet::addCommand	(	skui::Key	k,
		const char *	keyName,
		const char *	group,
		const char *	description,
		std::function< void(void)>	function
	)

Definition at line 84 of file CommandSet.cpp.

                                                                                       {
    fCommands.push_back(Command(k, keyName, group, description, function));
}

addCommand() [2/2]

void sk_app::CommandSet::addCommand	(	SkUnichar	c,
		const char *	group,
		const char *	description,
		std::function< void(void)>	function
	)

Definition at line 79 of file CommandSet.cpp.

                                                              {
    fCommands.push_back(Command(c, group, description, function));
}

attach()

void sk_app::CommandSet::attach

(

Window *

window

)

Definition at line 41 of file CommandSet.cpp.

                                      {
    fWindow = window;
}

drawHelp()

void sk_app::CommandSet::drawHelp

(

SkCanvas *

canvas

)

Definition at line 97 of file CommandSet.cpp.

                                          {
    if (kNone_HelpMode == fHelpMode) {
        return;
    }
 
    // Sort commands for current mode:
    std::stable_sort(fCommands.begin(), fCommands.end(),
                     kAlphabetical_HelpMode == fHelpMode ? compareCommandKey : compareCommandGroup);
 
    SkFont font = ToolUtils::DefaultPortableFont();
    font.setSize(16);
 
    SkFont groupFont;
    groupFont.setSize(18);
 
    SkPaint bgPaint;
    bgPaint.setColor(0xC0000000);
    canvas->drawPaint(bgPaint);
 
    SkPaint paint;
    paint.setAntiAlias(true);
    paint.setColor(0xFFFFFFFF);
 
    SkPaint groupPaint;
    groupPaint.setAntiAlias(true);
    groupPaint.setColor(0xFFFFFFFF);
 
    SkScalar x = SkIntToScalar(10);
    SkScalar y = SkIntToScalar(10);
 
    // Measure all key strings:
    SkScalar keyWidth = 0;
    for (Command& cmd : fCommands) {
        keyWidth = std::max(keyWidth,
                               font.measureText(cmd.fKeyName.c_str(), cmd.fKeyName.size(),
                                                SkTextEncoding::kUTF8));
    }
    keyWidth += font.measureText(" ", 1, SkTextEncoding::kUTF8);
 
    // If we're grouping by category, we'll be adding text height on every new group (including the
    // first), so no need to do that here. Otherwise, skip down so the first line is where we want.
    if (kGrouped_HelpMode != fHelpMode) {
        y += font.getSize();
    }
 
    // Print everything:
    SkString lastGroup;
    for (Command& cmd : fCommands) {
        if (kGrouped_HelpMode == fHelpMode && lastGroup != cmd.fGroup) {
            // Group change. Advance and print header:
            y += font.getSize();
            canvas->drawSimpleText(cmd.fGroup.c_str(), cmd.fGroup.size(), SkTextEncoding::kUTF8,
                                   x, y, groupFont, groupPaint);
            y += groupFont.getSize() + 2;
            lastGroup = cmd.fGroup;
        }
 
        canvas->drawSimpleText(cmd.fKeyName.c_str(), cmd.fKeyName.size(), SkTextEncoding::kUTF8,
                               x, y, font, paint);
        SkString text = SkStringPrintf(": %s", cmd.fDescription.c_str());
        canvas->drawString(text, x + keyWidth, y, font, paint);
        y += font.getSize() + 2;
    }
}

getCommandsAsSoftkeys()

std::vector< SkString > sk_app::CommandSet::getCommandsAsSoftkeys

(

)

const

Definition at line 162 of file CommandSet.cpp.

                                                            {
    std::vector<SkString> result;
    for(const Command& command : fCommands) {
        result.push_back(command.getSoftkeyString());
    }
    return result;
}

onChar()

bool sk_app::CommandSet::onChar	(	SkUnichar	c,
		skui::ModifierKey	modifiers
	)

Definition at line 58 of file CommandSet.cpp.

                                                              {
    for (Command& cmd : fCommands) {
        if (Command::kChar_CommandType == cmd.fType && c == cmd.fChar) {
            cmd.fFunction();
            return true;
        }
    }
 
    return false;
}

onKey()

bool sk_app::CommandSet::onKey	(	skui::Key	key,
		skui::InputState	state,
		skui::ModifierKey	modifiers
	)

Definition at line 45 of file CommandSet.cpp.

                                                                                   {
    if (skui::InputState::kDown == state) {
        for (Command& cmd : fCommands) {
            if (Command::kKey_CommandType == cmd.fType && key == cmd.fKey) {
                cmd.fFunction();
                return true;
            }
        }
    }
 
    return false;
}

onSoftkey()

bool sk_app::CommandSet::onSoftkey

(

const SkString &

softkey

)

Definition at line 69 of file CommandSet.cpp.

                                                  {
    for (const Command& cmd : fCommands) {
        if (cmd.getSoftkeyString().equals(softkey)) {
            cmd.fFunction();
            return true;
        }
    }
    return false;
}

---

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

• third_party/skia/tools/sk_app/CommandSet.h
• third_party/skia/tools/sk_app/CommandSet.cpp