LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
LeechCraft Namespace Reference

Namespaces

 AN
 
 Sync
 
 Util
 

Classes

class  IHookProxy
 Class for hook-based communication between plugins. More...
 
struct  ANFieldData
 A single additional AdvancedNotifications field. More...
 
struct  Request
 Describes the elementary subrequest. More...
 
struct  TabRecoverInfo
 Keeps the tab state between runs. More...
 
struct  ActionInfo
 Describes an action exposed in shortcut manager. More...
 
struct  TabClassInfo
 The structure describing a single tab class. More...
 
class  QuarkComponent
 Describes a single quark. More...
 
struct  Entity
 Describes parameters of an entity. More...
 
class  StandardException
 
class  DependencyException
 
class  InjectionFailureException
 
class  ReleaseFailureException
 
class  SerializationException
 
class  UnknownVersionException
 
struct  FlatTreeItem
 

Typedefs

typedef std::shared_ptr
< IHookProxy
IHookProxy_ptr
 
typedef QList< QPair
< QByteArray, QVariant > > 
DynPropertiesList_t
 
typedef QList< TabClassInfoTabClasses_t
 
typedef std::shared_ptr
< QuarkComponent
QuarkComponent_ptr
 A shared pointer to a quark. More...
 
typedef QList< QuarkComponent_ptrQuarkComponents_t
 A list of quarks pointers. More...
 
typedef std::shared_ptr
< FlatTreeItem
FlatTreeItem_ptr
 

Enumerations

enum  ActionsEmbedPlace {
  ActionsEmbedPlace::ToolsMenu,
  ActionsEmbedPlace::CommonContextMenu,
  ActionsEmbedPlace::QuickLaunch,
  ActionsEmbedPlace::TrayMenu,
  ActionsEmbedPlace::LCTray
}
 
enum  TabFeature {
  TFEmpty = 0x0,
  TFOpenableByRequest = 0x01,
  TFSingle = 0x02,
  TFByDefault = 0x04,
  TFSuggestOpening = 0x08
}
 Defines different behavior features of tab classes. More...
 
enum  JobHolderColumn {
  JobName,
  JobStatus,
  JobProgress
}
 
enum  JobHolderRow {
  Other,
  News,
  DownloadProgress,
  ProcessProgress
}
 
enum  ProcessState {
  Done = CustomDataRoles::RoleMAX + 1,
  Total,
  TaskFlags
}
 
enum  DeviceType {
  GenericDevice,
  MediaPlayer,
  MassStorage
}
 
enum  PartitionType {
  NonPartition = -1,
  Empty = 0x00,
  Win95FAT32 = 0x0b,
  Win95FAT32LBA = 0x0c
}
 
enum  DeviceRoles {
  DevType = Qt::UserRole + 1,
  DevFile,
  PartType,
  IsRemovable,
  IsPartition,
  IsMountable,
  IsMounted,
  IsMediaAvailable,
  DevID,
  VisibleName,
  AvailableSize,
  TotalSize,
  MountPoints,
  DeviceRoleMax
}
 
enum  ContentType {
  ContentType::HTML,
  ContentType::PlainText
}
 
enum  EditorAction {
  EditorAction::Find,
  EditorAction::Replace
}
 
enum  TaskParameter {
  NoParameters = 0,
  NoAutostart = 1,
  DoNotSaveInHistory = 2,
  IsDownloaded = 4,
  FromUserInitiated = 8,
  DoNotNotifyUser = 32,
  Internal = 64,
  NotPersistent = 128,
  DoNotAnnounceEntity = 256,
  OnlyHandle = 512,
  OnlyDownload = 1024,
  AutoAccept = 2048,
  ShouldQuerySource = 4096
}
 Describes single task parameter. More...
 
enum  CustomDataRoles {
  RoleTags = Qt::UserRole + 100,
  RoleControls,
  RoleAdditionalInfo,
  RoleHash,
  RoleMime,
  RoleContextMenu,
  RoleJobHolderRow,
  RoleMAX
}
 
enum  Priority {
  PLog_,
  PInfo_,
  PWarning_,
  PCritical_
}
 

Functions

 Q_DECLARE_FLAGS (TabFeatures, LeechCraft::TabFeature)
 
 Q_DECLARE_FLAGS (TaskParameters, TaskParameter)
 
FlatTreeItemToFlat (const QModelIndex &idx)
 
bool operator< (const LeechCraft::Entity &e1, const LeechCraft::Entity &e2)
 
bool operator== (const LeechCraft::Entity &e1, const LeechCraft::Entity &e2)
 

Typedef Documentation

typedef QList<QPair<QByteArray, QVariant> > LeechCraft::DynPropertiesList_t

Definition at line 100 of file ihaverecoverabletabs.h.

typedef std::shared_ptr<FlatTreeItem> LeechCraft::FlatTreeItem_ptr

Definition at line 42 of file flattofoldersproxymodel.h.

typedef std::shared_ptr<IHookProxy> LeechCraft::IHookProxy_ptr

Definition at line 129 of file ihookproxy.h.

A shared pointer to a quark.

Definition at line 127 of file iquarkcomponentprovider.h.

A list of quarks pointers.

Definition at line 131 of file iquarkcomponentprovider.h.

Definition at line 143 of file ihavetabs.h.

Enumeration Type Documentation

Enumerator
ToolsMenu 
CommonContextMenu 
QuickLaunch 
TrayMenu 
LCTray 

Definition at line 40 of file iactionsexporter.h.

Possible content types a text editor could handle.

Enumerator
HTML 

HTML content. The corresponding editor should provide WYSIWYG capabilities or at least some fancy highlighting for HTML.

PlainText 

Well, plain text.

Definition at line 45 of file itexteditor.h.

This enumeration describes the additional roles that may be returned from models that are embedded in Summary-like viewers. Those like IJobHolders or IFindProxies.

See Also
IJobHolder, IFindProxy
Enumerator
RoleTags 

The role for the string list with tags. So, QStringList is expected to be returned.

RoleControls 

The role for the additional controls for a given item. QToolBar* is expected to be returned.

RoleAdditionalInfo 

The role for the widget appearing on the right part of the screen when the user selects an item. QWidget* is expected to be returned.

RoleHash 

The role for the hash of the item, used to compare two different results, possibly from two different models. QByteArray is expected to be returned.

RoleMime 

This should return MIME of an item if it's available, otherwise an empty string should be returned.

RoleContextMenu 

This role returns the QMenu* that should be used as the context menu.

RoleJobHolderRow 

This role is for the LeechCraft::JobHolderRow enum.

RoleMAX 

Definition at line 243 of file structures.h.

Enumerator
DevType 
DevFile 
PartType 
IsRemovable 
IsPartition 
IsMountable 
IsMounted 
IsMediaAvailable 
DevID 
VisibleName 
AvailableSize 
TotalSize 
MountPoints 
DeviceRoleMax 

Definition at line 55 of file iremovabledevmanager.h.

Enumerator
GenericDevice 
MediaPlayer 
MassStorage 

Definition at line 40 of file iremovabledevmanager.h.

Enumeration for some standard editor actions.

Enumerator
Find 
Replace 

Definition at line 59 of file itexteditor.h.

Enumerator
JobName 
JobStatus 
JobProgress 

Definition at line 41 of file ijobholder.h.

Values of this enum are used to describe the semantics of rows in the representation models.

Values of this enum are expected to be obtained via the CustomDataRoles::RoleJobHolderRow role.

Enumerator
Other 

This row corresponds to something that cannot be described by other enum members.

News 

This row corresponds to a news item, say, in an RSS reader or a Twitter client.

DownloadProgress 

This row corresponds to a pending download like in a BitTorrent client or an HTTP downloader.

If a row has this type, then it also has to have meaningful values for ProcessState::Done and ProcessState::Total roles. These values are expected to be contained in the Progress column (the third column).

ProcessProgress 

This row corresponds to some process like sending a file in IM, unpacking an archive or checking for new mail.

If a row has this type, then it also has to have meaningful values for ProcessState::Done and ProcessState::Total roles. These values are expected to be contained in the Progress column (the third column).

Definition at line 54 of file ijobholder.h.

Enumerator
NonPartition 
Empty 
Win95FAT32 
Win95FAT32LBA 

Definition at line 47 of file iremovabledevmanager.h.

Enumerator
PLog_ 
PInfo_ 
PWarning_ 
PCritical_ 

Definition at line 284 of file structures.h.

This enum contains roles that are used to query against process or download completion.

Rows of types JobHolderRow::DownloadProgress and JobHolderRow::ProcessProgress are expected to return meaningful values for roles of this enum.

Enumerator
Done 

This role is expected to contain a qlonglong meaning how much of the task is completed. For example, how much bytes are transferred for a download task or how much files are unpacked in an archive.

Total 

This role is expected to contain a qlonglong meaning the total size of the task. For example, how big is the file to be downloaded, or how many files an archive contains.

TaskFlags 

This role is expected to contain the flags of the task as it was originally added to the downloader.

Definition at line 94 of file ijobholder.h.

Defines different behavior features of tab classes.

Enumerator
TFEmpty 

No special features.

TFOpenableByRequest 

This tab could be opened by user request.

If tab class has this feature, a corresponding action in new tab menu would be created to allow the user to open this tab.

If tab class doesn't have this feature, the only way for the tab to be opened is for the corresponding to emit the IHaveTabs::addNewTab() signal when needed.

See Also
TFSingle.
TFSingle 

There could be only one instance of this tab.

By default, LeechCraft considers that each tab having the TFOpenableByRequest feature could be opened multiple times, but sometimes it doesn't make sense to have more than one tab of some class. In this case, this feature should also be present for that tab class.

This feature requires the TFOpenableByRequest feature as well.

See Also
TFOpenableByRequest.
TFByDefault 

The tab should be opened by default.

By default, all tabs are hidden, both having TFSingle feature and lacking it. If a tab wants to be shown after LeechCraft startup until the user manually closes it, the corresponding tab class should have this feature as well.

TFSuggestOpening 

The tab is to be suggested in a quick launch area.

Tabs having this flag are expected to be contained by default in some kind of quick launch area like the one in the Sidebar plugin.

Consider adding this flag if you think user would often open tabs of your class.

Definition at line 42 of file ihavetabs.h.

Describes single task parameter.

Enumerator
NoParameters 

Use default parameters.

NoAutostart 

Task should not be started automatically after addition.

DoNotSaveInHistory 

Task should not be saved in history.

IsDownloaded 

Task is really downloaded, so, a file, for example, has appeared as a result.

FromUserInitiated 

Task is created as a result of user's actions.

DoNotNotifyUser 

User should not be notified about task finish.

Internal 

Task is used internally and would not be visible to the user at all.

NotPersistent 

Task should not be saved as it would have no meaning after next start.

DoNotAnnounceEntity 

When the task is finished, it should not be announced via gotEntity() signal.

OnlyHandle 

This task should not be downloaded, only handled by a handler.

OnlyDownload 

This task should not be handled, only downloaded by a downloader.

AutoAccept 

This task should be automatically accepted if any handler is available.

ShouldQuerySource 

The plugin that was the source of this task should be queried if it could handle the task.

Definition at line 50 of file structures.h.

Function Documentation

UTIL_API bool LeechCraft::operator< ( const LeechCraft::Entity e1,
const LeechCraft::Entity e2 
)
LeechCraft::Q_DECLARE_FLAGS ( TabFeatures  ,
LeechCraft::TabFeature   
)
LeechCraft::Q_DECLARE_FLAGS ( TaskParameters  ,
TaskParameter   
)