就业培训     下载中心     Wiki     联络 登录   注册

---

◆  anonymous enum

构造函数 & 析构函数文档编制

◆  SDKBrowserContentNodeInfo()

Constructor.

参数

[in]

plugin_id

The ID of the plugin that has created the node info.

◆  ~SDKBrowserContentNodeInfo()

A dummy destructor to make the compiler happy.

成员函数文档编制

◆  GetNode()

Retrieves the corresponding node.

返回

The node corresponding to this info.

◆  Init()

Called by the browser with pointer to the corresponding node.

参数

[in]

node

Pointer to the node.

返回

true if successful, otherwise false .

◆  Free()

Called by the browser before the node is deleted (overload this to dispose of the SDKBrowserContentNodeInfo at a later time).

◆  GetTypeID()

Called to retrieve the type of content node.

返回

The content node type ID. See SDKBrowserNodeTypeID .

◆  GetPlugin()

Called to retrieve a plugin that can deal with the file.

参数

[in]

flags

The flags.

返回

A plugin that can deal with the file of the node.

◆  GetName()

Called to retrieve the name of the content node (used in the UI).

返回

The name of the content node.

◆  GetTypeName()

Called to retrieve the type name of the content node.

参数

[in]

mode

The mode. See SDKBrowserItemType .

返回

The type name.

◆  GetNodeURL()

Called to retrieve the URL of the content node (this is the file name if the node represents a file or folder in the file system).
If there are multiple objects in a file (e.g. presets) the return value should reflect the index.

参数

[out]	url	Assign the URL.
[in]	flags	The flags.

返回

The index, if there are multiple objects.

◆  GetNodeTime()

Called to retrieve the creation and last modification time of a node (this will usually be the file times).
For a directory the modification time will usually be the time when a file has been added or removed.

参数

[in]	mode	The mode: GE_FILETIME
[out]	out	Assign the time.

返回

true if successful, otherwise false .

◆  GetNodeFlags()

Called to retrieve some node flags.

参数

[in]

out_size

Assign the size of the output.

返回

The node flags. See SDKBrowserNodeFlags .

◆  GetIcon()

Called to retrieve the icon for this kind of file.

参数

[in]	flags	The flags. See SDKBrowserIcon .
[in]	pref_wh	The preferred width/height of the icon.

返回

The browser icon for the node. The caller owns the returned icon and has to call SDKBrowserIcon::Free() to free it.

◆  UpdateDirectory()

Called before GetDown() is used to search for children (mainly for file system based trees).

返回

Not used.

◆  PrivateCall()

Hook for private calls. The plugin_id and node_type parameters should be used to validate the call, so that if a call is made to the wrong node it will do nothing.

参数

[in]	plugin_id	Must be the same as GetPlugin()->GetPluginID() .
[in]	node_type	Must be the same as GetTypeID() .
[in]	selector	The private method index.
[in]	data	The private data.

返回

NOTOK if not successful.

◆  Rename()

Called to rename the node.

参数

[in]	mode	The mode. Either CheckOperation or PerformOperation .
[in]	name	The new name.

返回

The result. See SDKBrowserOperationResult .

◆  NewFolder()

Called to create a new folder.

参数

[in]	mode	The mode. Either CheckOperation or PerformOperation .
[in]	name	A unique name.
[in]	folder	The node folder.

返回

The result. See SDKBrowserOperationResult .

◆  MoveFrom()

Called to move nodes (the node will be the new parent).

参数

[in]	new_child	The new child.
[in]	mode	The mode. See SDKBrowserOperation .
[in]	callback	The callback, e.g. for progress report. Only called for PrepareOperation and PerformOperation 模式。
[in]	private_data	Private data for the callback.
[in]	thread	The thread.

返回

The result. See SDKBrowserOperationResult .

◆  CopyFrom()

Called to copy nodes (the node will be the new parent).

参数

[in]	new_child	The new child.
[in]	mode	The mode. See SDKBrowserOperation .
[in]	rename	Pointer to a string if new_child has to be renamed to avoid a name conflict. Can be nullptr .
[in]	callback	The callback, e.g. for progress report. Only called for PrepareOperation and PerformOperation 模式。
[in]	private_data	Private data for the callback.
[in]	thread	The thread.

返回

The result. See SDKBrowserOperationResult .

◆  Delete()

Called to delete the node and its children.

参数

[in]	mode	The mode. See SDKBrowserOperation .
[in]	callback	The callback, e.g. for progress report. Only called for PrepareOperation and PerformOperation 模式。
[in]	private_data	Private data for the callback.
[in]	thread	The thread.

返回

The result. See SDKBrowserOperationResult .

Friends And Related Function Documentation

◆  SDKBrowserContentNode

◆  SDKNode

Member Data Documentation

◆  plugin_id

◆  node

• SDKBrowserContentNodeInfo