![]() |
LeechCraft
0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
|
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... | |
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.
The typical values for the priority.
Enumerator | |
---|---|
PIdeal | |
PHigh | |
PNormal | |
PLow | |
PNone |
Definition at line 40 of file entitytesthandleresult.h.
|
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.
|
inlineexplicit |
Constructs a test result with given predefined priority.
[in] | prio | One of the predefined priorities. |
Definition at line 71 of file entitytesthandleresult.h.
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.
int EntityTestHandleResult::HandlePriority_ |
The priority with which an entity could be handled.
Definition at line 36 of file entitytesthandleresult.h.