eve::editor::EditorToolbar类 参考

Tool strip state for assembling editor chrome with ui. 更多...

#include <EditorToolbar.h>

Public 成员函数
void	clear ()
	Clears .
void	addTool (const std::string &id, const std::string &label)
	Adds tool.
void	setIcon (const std::string &id, const std::string &icon)
	Assigns a backend-neutral semantic icon name to an existing tool.
void	setShortcut (const std::string &id, const std::string &key)
	Sets the shortcut.
bool	setActive (const std::string &id)
	Sets the active.
std::string	getActive () const
	Returns the active.
bool	matchShortcut (const std::string &key)
	Match shortcut.
int	getToolCount () const
	Returns the tool count.
std::string	getToolId (int index) const
	Returns the tool id.
std::string	getToolLabel (int index) const
	Returns the tool label.
std::string	getToolIcon (int index) const
	Returns the tool's semantic icon name.
std::string	getToolShortcut (int index) const
	Returns the tool shortcut.

详细描述

Tool strip state for assembling editor chrome with ui.

在文件 EditorToolbar.h 第 11 行定义.

成员函数说明

addTool()

void eve::editor::EditorToolbar::addTool	(	const std::string &	id,
		const std::string &	label
	)

Adds tool.

在文件 EditorToolbar.cpp 第 19 行定义.

引用了 id , 以及 label.

clear()

void eve::editor::EditorToolbar::clear

(

)

Clears .

在文件 EditorToolbar.cpp 第 7 行定义.

getActive()

std::string eve::editor::EditorToolbar::getActive ( ) const

inline

Returns the active.

在文件 EditorToolbar.h 第 29 行定义.

getToolCount()

int eve::editor::EditorToolbar::getToolCount ( ) const

inline

Returns the tool count.

在文件 EditorToolbar.h 第 35 行定义.

getToolIcon()

std::string eve::editor::EditorToolbar::getToolIcon

(

int

index

)

const

Returns the tool's semantic icon name.

参数

index

Zero-based tool index.

返回

Owning icon-name snapshot; empty means the presenter should use the label.

异常

Exception

when index is out of range.

在文件 EditorToolbar.cpp 第 66 行定义.

引用了 index.

getToolId()

std::string eve::editor::EditorToolbar::getToolId

(

int

index

)

const

Returns the tool id.

在文件 EditorToolbar.cpp 第 54 行定义.

引用了 index.

getToolLabel()

std::string eve::editor::EditorToolbar::getToolLabel

(

int

index

)

const

Returns the tool label.

在文件 EditorToolbar.cpp 第 60 行定义.

引用了 index.

getToolShortcut()

std::string eve::editor::EditorToolbar::getToolShortcut

(

int

index

)

const

Returns the tool shortcut.

在文件 EditorToolbar.cpp 第 72 行定义.

引用了 index.

matchShortcut()

bool eve::editor::EditorToolbar::matchShortcut

(

const std::string &

key

)

Match shortcut.

在文件 EditorToolbar.cpp 第 44 行定义.

引用了 key , 以及 t.

setActive()

bool eve::editor::EditorToolbar::setActive

(

const std::string &

id

)

Sets the active.

在文件 EditorToolbar.cpp 第 38 行定义.

引用了 id.

setIcon()

void eve::editor::EditorToolbar::setIcon	(	const std::string &	id,
		const std::string &	icon
	)

Assigns a backend-neutral semantic icon name to an existing tool.

参数

id	Stable tool id.
icon	Semantic icon name understood by the presenting UI.

异常

Exception

when id is unknown.

在文件 EditorToolbar.cpp 第 26 行定义.

引用了 icon.

setShortcut()

void eve::editor::EditorToolbar::setShortcut	(	const std::string &	id,
		const std::string &	key
	)

Sets the shortcut.

在文件 EditorToolbar.cpp 第 32 行定义.

引用了 key.

---

该类的文档由以下文件生成:

• src/modules/editor/EditorToolbar.h
• src/modules/editor/EditorToolbar.cpp