ToolHintsInterface Class Reference

#include <lib_toolhints.h>

Detailed Description

This interface allows to add resources containing the tool hints to a global storage.

Classes
struct	ToolHint

Public Types
enum class	QUALIFIER : UChar {   NONE ,   SHIFT ,   CTRL ,   ALT }
enum class	MOSUE_BUTTON : UChar {   NONE ,   LEFT ,   MIDDLE ,   RIGHT }

Public Member Functions
enum maxon::ToolHintsInterface::QUALIFIER UChar	MAXON_ENUM_FLAGS_CLASS (QUALIFIER)
enum maxon::ToolHintsInterface::MOSUE_BUTTON UChar	MAXON_ENUM_LIST_CLASS (MOSUE_BUTTON)

Static Public Member Functions
static MAXON_METHOD Result< void >	AddToolHints (const Url &url)
static MAXON_METHOD StridedBlock< const ToolHint >	GetToolHints (Int32 toolId)

Public Attributes
struct maxon::ToolHintsInterface::ToolHint	MAXON_ENUM_LIST_CLASS

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (ToolHintsInterface, MAXON_REFERENCE_STATIC, "net.maxon.c4dbase.toolhints")

Member Enumeration Documentation

QUALIFIER

enum QUALIFIER : UChar

strong

Enumerator
NONE
SHIFT
CTRL
ALT

MOSUE_BUTTON

enum MOSUE_BUTTON : UChar

strong

Enumerator
NONE
LEFT
MIDDLE
RIGHT

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( ToolHintsInterface  , MAXON_REFERENCE_STATIC  , "net.maxon.c4dbase.toolhints"    )

private

MAXON_ENUM_FLAGS_CLASS()

enum maxon::ToolHintsInterface::QUALIFIER UChar MAXON_ENUM_FLAGS_CLASS

(

QUALIFIER

)

MAXON_ENUM_LIST_CLASS()

enum maxon::ToolHintsInterface::MOSUE_BUTTON UChar MAXON_ENUM_LIST_CLASS

(

MOSUE_BUTTON

)

AddToolHints()

static MAXON_METHOD Result<void> AddToolHints ( const Url &  url )

static

Adds an URL containg tool hints to the storage.

Parameters

[in]

url

Url of the file containing the hints.

Returns

OK on success.

GetToolHints()

static MAXON_METHOD StridedBlock<const ToolHint> GetToolHints ( Int32  toolId )

static

Gets the tool hints for a specific tool. If there are no hints, an empty block is returned.

Parameters

[in]

toolId

Tool ID.

Returns

Hints for the specified tool.

Member Data Documentation

MAXON_ENUM_LIST_CLASS

struct maxon::ToolHintsInterface::ToolHint MAXON_ENUM_LIST_CLASS