![]() |
LeechCraft 0.6.70-16373-g319c272718
Modular cross-platform feature rich live environment.
|
Namespaces | |
namespace | AN |
namespace | EF |
The various Additional_ entity fields. | |
namespace | Mimes |
The various well-known values of the inter-plugin Entity's MIME_ field. | |
namespace | PowerState |
The values of the Entity::Entity_ corresponding to LC::Mimes::PowerStateChanged. | |
namespace | Util |
Classes | |
struct | ActionInfo |
Describes an action exposed in shortcut manager. More... | |
struct | ANBoolFieldValue |
Describes a field with boolean values. More... | |
struct | ANFieldData |
A single additional AdvancedNotifications field. More... | |
struct | ANIntFieldValue |
Describes a field with integer values. More... | |
struct | ANStringFieldValue |
Describes a field with QString values. More... | |
struct | Entity |
A message used for inter-plugin communication. More... | |
class | IHookProxy |
Class for hook-based communication between plugins. More... | |
struct | ImageServiceInfo |
Describes a single image hosting service (including account). More... | |
struct | ProcessStateInfo |
State of a single process represented in a IJobHolder model. More... | |
class | QuarkComponent |
Describes a single quark. More... | |
struct | RemoteImageInfo |
Describes a remote image. More... | |
struct | Request |
Describes the elementary subrequest. More... | |
struct | TabClassInfo |
The structure describing a single tab class. More... | |
struct | TabRecoverInfo |
Keeps the tab state between runs. More... | |
Typedefs | |
using | ANFieldValue = std::variant<ANBoolFieldValue, ANIntFieldValue, ANStringFieldValue> |
A combination of all possible descriptions. | |
typedef std::shared_ptr< IHookProxy > | IHookProxy_ptr |
typedef QList< ImageServiceInfo > | ImageServiceInfos_t |
The list of image storage service descriptions. | |
typedef QList< RemoteImageInfo > | RemoteImageInfos_t |
A list of remote images. | |
typedef QList< QPair< QByteArray, QVariant > > | DynPropertiesList_t |
typedef QList< TabClassInfo > | TabClasses_t |
typedef std::shared_ptr< QuarkComponent > | QuarkComponent_ptr |
A shared pointer to a quark. | |
typedef QList< QuarkComponent_ptr > | QuarkComponents_t |
A list of quarks pointers. | |
Enumerations | |
enum | PartitionType { NonPartition = -1 , Empty = 0x00 , Win95FAT32 = 0x0b , Win95FAT32LBA = 0x0c } |
Describes the various common partition types. More... | |
enum | CommonDevRole { DevType = Qt::UserRole + 1 , DevID , DevPersistentID , CommonDevRoleMax } |
Roles for both USB Mass Storage and generic USB devices. More... | |
enum | USBDeviceRole { ID = CommonDevRole::CommonDevRoleMax + 1 , Busnum , Devnum , VendorID , Vendor , ModelID , Model , SysFile , USBDeviceRoleMax } |
Roles specific to generic USB devices. More... | |
enum | MassStorageRole { DevFile = USBDeviceRole::USBDeviceRoleMax + 1 , PartType , IsRemovable , IsPartition , IsMountable , IsMounted , IsMediaAvailable , VisibleName , AvailableSize , TotalSize , MountPoints , MassStorageRoleMax } |
Roles specific to mass storage USB devices. More... | |
enum | DeviceType { USBDevice , MassStorage } |
Describes various USB removable devices. More... | |
enum class | ActionsEmbedPlace { ToolsMenu , CommonContextMenu , QuickLaunch , TrayMenu , LCTray } |
Specifies where the actions should be embedded. More... | |
enum | TabFeature { TFEmpty = 0x0 , TFOpenableByRequest = 1 << 0 , TFSingle = 1 << 1 , TFByDefault = 1 << 2 , TFSuggestOpening = 1 << 3 , TFOverridesTabClose = 1 << 4 } |
Defines different behavior features of tab classes. More... | |
enum | JobHolderColumn { JobName , JobStatus , JobProgress } |
Describes the columns in a job holder model. More... | |
enum | JobHolderRow { Other , News , DownloadProgress , ProcessProgress } |
Describes the semantics of a row in a job holder model. More... | |
enum | JobHolderRole { ProcessState = CustomDataRoles::RoleMAX + 1 , JobHolderRoleMax } |
This enum contains roles that are used to query job states. More... | |
enum class | ContentType { HTML , PlainText } |
enum class | EditorAction { Find , Replace } |
Enumeration for some standard editor actions. More... | |
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 , FromCommandLine = 4096 } |
Describes single task parameter. More... | |
enum | CustomDataRoles { RoleTags = Qt::UserRole + 100 , RoleControls , RoleAdditionalInfo , RoleHash , RoleMime , RoleContextMenu , RoleJobHolderRow , RoleMAX } |
enum class | Priority { Info , Warning , Critical } |
Functions | |
Q_DECLARE_FLAGS (TabFeatures, LC::TabFeature) | |
Q_DECLARE_FLAGS (TaskParameters, TaskParameter) | |
constexpr QColor | operator""_rgb (const char *str, std::size_t size) |
template<Util::CtString S> | |
constexpr auto | operator""_ct () noexcept |
constexpr QLatin1String | operator""_ql (const char *str, std::size_t size) noexcept |
constexpr QStringView | operator""_qsv (const char16_t *str, std::size_t size) noexcept |
QByteArray | operator""_qba (const char *str, std::size_t size) noexcept |
template<Util::CtString S> | |
QString | operator""_qs () |
constexpr quint64 | operator""_mib (quint64 mibs) noexcept |
bool | operator< (const LC::Entity &e1, const LC::Entity &e2) |
bool | operator== (const LC::Entity &e1, const LC::Entity &e2) |
template<typename L , typename R > | |
Util::detail::EitherAwaiter< L, R > | operator co_await (const Util::Either< L, R > &either) |
UTIL_THREADS_API Util::detail::NRAwaiter | operator co_await (QNetworkReply &reply) |
Util::detail::TimerAwaiter | operator co_await (std::chrono::milliseconds duration) |
Variables | |
Q_DECL_IMPORT const QString | IgnoreSelf { QStringLiteral ("IgnoreSelf") } |
Q_DECL_IMPORT const QString | AllowedSemantics { QStringLiteral ("AllowedSemantics") } |
using LC::ANFieldValue = std::variant<ANBoolFieldValue, ANIntFieldValue, ANStringFieldValue> |
A combination of all possible descriptions.
Definition at line 178 of file ianemitter.h.
typedef QList<QPair<QByteArray, QVariant> > LC::DynPropertiesList_t |
Definition at line 79 of file ihaverecoverabletabs.h.
typedef std::shared_ptr<IHookProxy> LC::IHookProxy_ptr |
Definition at line 108 of file ihookproxy.h.
typedef QList<ImageServiceInfo> LC::ImageServiceInfos_t |
The list of image storage service descriptions.
Definition at line 37 of file iimgsource.h.
typedef std::shared_ptr<QuarkComponent> LC::QuarkComponent_ptr |
A shared pointer to a quark.
Definition at line 133 of file iquarkcomponentprovider.h.
typedef QList<QuarkComponent_ptr> LC::QuarkComponents_t |
A list of quarks pointers.
Definition at line 137 of file iquarkcomponentprovider.h.
typedef QList<RemoteImageInfo> LC::RemoteImageInfos_t |
A list of remote images.
Definition at line 81 of file iimgsource.h.
typedef QList<TabClassInfo> LC::TabClasses_t |
Definition at line 131 of file ihavetabs.h.
|
strong |
Specifies where the actions should be embedded.
Enumerator | |
---|---|
ToolsMenu | The Tools submenu of main LeechCraft menu. |
CommonContextMenu | The common tabbar context menu. This menu is used to open new tabs, close opened tabs and manipulate already opened tabs. Plugins will typically embed actions that don't relate to any currently opened tab but should be invoked easily by the user. |
QuickLaunch | The quick launch area. The quick launch area resides in the SB2 panel or similar. Actions and menus embedded in such areas are always visible by the user (unless they hide it explicitly). So, this area can be used to either perform some actions in one click (even faster than ToolsMenu) or to host actions displaying state, like a network monitor. This area is similar to LCTray but with more focus on performing actions.
|
TrayMenu | The context menu of the LeechCraft tray icon. |
LCTray | The tray area. Similar to QuickLaunch, but with more focus on displaying state.
|
Definition at line 21 of file iactionsexporter.h.
enum LC::CommonDevRole |
Roles for both USB Mass Storage and generic USB devices.
Enumerator | |
---|---|
DevType | The type of the device. This role is expected to contain a member of the DeviceType enum.
|
DevID | The unique device ID (QString). |
DevPersistentID | The persistent unique device ID (QString). |
CommonDevRoleMax |
Definition at line 44 of file deviceroles.h.
|
strong |
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 22 of file itexteditor.h.
enum LC::CustomDataRoles |
This enumeration describes the additional roles that may be returned from models that are embedded in Summary-like viewers. Those like IJobHolders or IFindProxies.
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 LC::JobHolderRow enum. |
RoleMAX |
Definition at line 173 of file structures.h.
enum LC::DeviceType |
Describes various USB removable devices.
The corresponding device model role is CommonDevRole::DevType.
All device types are expected to return meaningful data for roles in the CommonDevRole enum.
Enumerator | |
---|---|
USBDevice | A general USB device. The device model rows for this USB device are expected to also return data for roles in the USBDeviceRole enum.
|
MassStorage | A mass storage USB device, like a flash drive. The device model rows for this USB device are expected to also return data for roles in the MassStorageRole enum.
|
Definition at line 23 of file devicetypes.h.
|
strong |
Enumeration for some standard editor actions.
The corresponding actions may be retrieved via ITextEditor::GetEditorAction().
Enumerator | |
---|---|
Find | Open "Find" dialog. |
Replace | Open "Replace" dialog. |
Definition at line 41 of file itexteditor.h.
enum LC::JobHolderColumn |
Describes the columns in a job holder model.
A job holder model has a fixed number of columns, and this enum gives them meaningful names.
Definition at line 24 of file ijobholder.h.
enum LC::JobHolderRole |
This enum contains roles that are used to query job states.
Enumerator | |
---|---|
ProcessState | Describes the state of a process. This role should return a meaningful value for the JobHolderRow::DownloadProgress and JobHolderRow::ProcessProgress rows. The returned value should be a ProcessStateInfo structure.
|
JobHolderRoleMax |
Definition at line 184 of file ijobholder.h.
enum LC::JobHolderRow |
Describes the semantics of a row in a job holder model.
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 process state for the JobHolderRole::ProcessState role. |
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 process state for the JobHolderRole::ProcessState role. |
Definition at line 50 of file ijobholder.h.
enum LC::MassStorageRole |
Roles specific to mass storage USB devices.
The corresponding CommonDevRole::DevType is DeviceType::MassStorage.
Enumerator | |
---|---|
DevFile | The device file representing the device (QString). For example, it could be /dev/sdc1 on a Linux system. |
PartType | The type of the partition. This role is expected to contain a member of the PartitionType enum.
|
IsRemovable | Whether this item is removable (bool). |
IsPartition | Whether this item is a partition (bool). |
IsMountable | Whether this item could be mounted (bool). |
IsMounted | Whether this item is currently mounted (bool). |
IsMediaAvailable | Whether this item contains media (bool). For example, a CD in a CD-ROM. |
VisibleName | Human-readable name of the device (QString). |
AvailableSize | Available size in bytes (qint64). If the value is -1, the available size is not known. It is very likely the available size wouldn't be known for unmounted devices. |
TotalSize | Total size in bytes (qint64). If the value is -1, the available size is not known. It is very likely the total size wouldn't be known for unmounted devices. |
MountPoints | The list of directories this item is mounted to (QStringList). |
MassStorageRoleMax |
Definition at line 113 of file deviceroles.h.
enum LC::PartitionType |
Describes the various common partition types.
This enum is used for USB Mass Storage devices and similar ones where the concept of a partition makes sense.
Enumerator | |
---|---|
NonPartition | Something other than a partition. |
Empty | Empty partition without a type. |
Win95FAT32 | FAT32 partition. |
Win95FAT32LBA | FAT32 partition with LBA. |
Definition at line 23 of file deviceroles.h.
|
strong |
Enumerator | |
---|---|
Info | |
Warning | |
Critical |
Definition at line 214 of file structures.h.
enum LC::TabFeature |
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.
|
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.
|
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. |
TFOverridesTabClose | The tab uses the standard tab close shortcut (Ctrl+W). Thus, when this tab is active, the tab close shortcut will be disabled if it matches "Ctrl+W". |
Definition at line 21 of file ihavetabs.h.
enum LC::TaskParameter |
Describes single task parameter.
Definition at line 23 of file structures.h.
enum LC::USBDeviceRole |
Roles specific to generic USB devices.
The corresponding CommonDevRole::DevType is DeviceType::USBDevice.
Definition at line 69 of file deviceroles.h.
Util::detail::EitherAwaiter< L, R > LC::operator co_await | ( | const Util::Either< L, R > & | either | ) |
UTIL_THREADS_API Util::detail::NRAwaiter LC::operator co_await | ( | QNetworkReply & | reply | ) |
Definition at line 50 of file networkreply.cpp.
UTIL_THREADS_API Util::detail::TimerAwaiter LC::operator co_await | ( | std::chrono::milliseconds | duration | ) |
|
constexprnoexcept |
Definition at line 166 of file ctstring.h.
|
inlinenoexcept |
|
constexprnoexcept |
QString LC::operator""_qs | ( | ) |
Definition at line 157 of file qtutil.h.
References LC::Util::ToString().
|
constexprnoexcept |
|
constexpr |
UTIL_API bool LC::operator< | ( | const LC::Entity & | e1, |
const LC::Entity & | e2 ) |
Definition at line 110 of file structuresops.cpp.
References LC::Entity::Location_, LC::Entity::Mime_, and LC::Entity::Parameters_.
UTIL_API bool LC::operator== | ( | const LC::Entity & | e1, |
const LC::Entity & | e2 ) |
Definition at line 117 of file structuresops.cpp.
References LC::Entity::Additional_, LC::Entity::Entity_, LC::Entity::Location_, LC::Entity::Mime_, and LC::Entity::Parameters_.
LC::Q_DECLARE_FLAGS | ( | TabFeatures | , |
LC::TabFeature | ) |
LC::Q_DECLARE_FLAGS | ( | TaskParameters | , |
TaskParameter | ) |
const QString LC::AllowedSemantics { QStringLiteral ("AllowedSemantics") } |
Definition at line 17 of file anconstantsdefs.cpp.
const QString LC::IgnoreSelf { QStringLiteral ("IgnoreSelf") } |
Definition at line 16 of file anconstantsdefs.cpp.