LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
EntityTestHandleResult Struct Reference

The result of testing whether the entity could be handled. More...

#include "entitytesthandleresult.h"

Public Types

enum  Priority {
  PIdeal = 1000,
  PHigh = 800,
  PNormal = 600,
  PLow = 200,
  PNone = 0
}
 

Public Member Functions

 EntityTestHandleResult ()
 
 EntityTestHandleResult (Priority prio)
 

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 the entity could be handled.

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

Definition at line 38 of file entitytesthandleresult.h.

Member Enumeration Documentation

enum EntityTestHandleResult::Priority
Enumerator
PIdeal 
PHigh 
PNormal 
PLow 
PNone 

Definition at line 49 of file entitytesthandleresult.h.

Constructor & Destructor Documentation

EntityTestHandleResult::EntityTestHandleResult ( )
inline

Definition at line 65 of file entitytesthandleresult.h.

EntityTestHandleResult::EntityTestHandleResult ( Priority  prio)
inlineexplicit

Definition at line 71 of file entitytesthandleresult.h.

Member Data Documentation

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 63 of file entitytesthandleresult.h.

int EntityTestHandleResult::HandlePriority_

The priority with which an entity could be handled.

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 47 of file entitytesthandleresult.h.

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