The result of testing whether an entity could be handled by a plugin. More...

#include "entitytesthandleresult.h"

Public Types
enum	Priority { PIdeal = 1000, PHigh = 800, PNormal = 600, PLow = 200, PNone = 0 }
	The typical values for the priority. More...

Public Member Functions
	EntityTestHandleResult ()
	Default-constructs a test result. More...

	EntityTestHandleResult (Priority prio)
	Constructs a test result with given predefined priority. More...

Public Attributes
int	HandlePriority_
	The priority with which an entity could be handled. More...

bool	CancelOthers_
	Whether other handlers should be canceled. More...

Detailed Description

The result of testing whether an entity could be handled by a plugin.

Both processing an Entity with IEntityHandler and IDownload are considered to be "handling".

The test result also includes the so-called priority which shows how much the plugin is ready to handle the entity. The higher is the priority, the more ready the plugin is to handle the entity.

Typically the handler with the highest priority will be chosen. A value of 0 or lower means that the given entity can't be handled by this handler/downloader at all.

Definition at line 26 of file entitytesthandleresult.h.

Member Enumeration Documentation

◆ Priority

enum EntityTestHandleResult::Priority

The typical values for the priority.

Enumerator
PIdeal
PHigh
PNormal
PLow
PNone

Definition at line 40 of file entitytesthandleresult.h.

Constructor & Destructor Documentation

◆ EntityTestHandleResult() [1/2]

EntityTestHandleResult::EntityTestHandleResult ( )

inline

Default-constructs a test result.

The default-constructed entity test handle result can't handle anything.

Definition at line 61 of file entitytesthandleresult.h.

◆ EntityTestHandleResult() [2/2]

EntityTestHandleResult::EntityTestHandleResult ( Priority prio )

inlineexplicit

Constructs a test result with given predefined priority.

Parameters

[in] prio One of the predefined priorities.

Definition at line 71 of file entitytesthandleresult.h.

Member Data Documentation

◆ CancelOthers_

bool EntityTestHandleResult::CancelOthers_

Whether other handlers should be canceled.

If this is set to true, then other handlers won't be called to handle the given entity.

Definition at line 54 of file entitytesthandleresult.h.

◆ HandlePriority_

int EntityTestHandleResult::HandlePriority_

The priority with which an entity could be handled.

Definition at line 36 of file entitytesthandleresult.h.

The documentation for this struct was generated from the following file:

/home/d34df00d/leechcraft/src/interfaces/entitytesthandleresult.h

Public Types

Public Member Functions

Public Attributes