TorrentFileGuard Class Reference

#include <torrentfileguard.h>

Inheritance diagram for TorrentFileGuard:

Collaboration diagram for TorrentFileGuard:

Public Types
enum	AutoDeleteMode : int { Never , IfAdded , Always }

Public Member Functions
	TorrentFileGuard (const QString &path={})
	~TorrentFileGuard ()
void	markAsAddedToSession ()
	marks the torrent file as loaded (added) into the BitTorrent::Session More...
void	setAutoRemove (bool remove) noexcept
	Cancels or re-enables deferred file deletion. More...

Static Public Member Functions
static AutoDeleteMode	autoDeleteMode ()
static void	setAutoDeleteMode (AutoDeleteMode mode)

Private Member Functions
	TorrentFileGuard (const QString &path, AutoDeleteMode mode)
Private Member Functions inherited from FileGuard
	FileGuard (const QString &path={})
	~FileGuard ()
void	setAutoRemove (bool remove) noexcept
	Cancels or re-enables deferred file deletion. More...

Static Private Member Functions
static SettingValue< AutoDeleteMode > &	autoDeleteModeSetting ()

Private Attributes
AutoDeleteMode	m_mode
bool	m_wasAdded

Detailed Description

Reads settings for .torrent files from preferences and sets the file guard up accordingly

Definition at line 53 of file torrentfileguard.h.

Member Enumeration Documentation

AutoDeleteMode

enum TorrentFileGuard::AutoDeleteMode : int

Enumerator
Never
IfAdded
Always

Definition at line 65 of file torrentfileguard.h.

    {
        Never,
        IfAdded,
        Always
    };

Constructor & Destructor Documentation

TorrentFileGuard() [1/2]

TorrentFileGuard::TorrentFileGuard ( const QString &  path = {} )

explicit

Definition at line 58 of file torrentfileguard.cpp.

    : TorrentFileGuard {path, autoDeleteMode()}
{
}

~TorrentFileGuard()

TorrentFileGuard::~TorrentFileGuard

(

)

Definition at line 63 of file torrentfileguard.cpp.

{
    if (!m_wasAdded && (m_mode != Always))
        setAutoRemove(false);
}

References Always, m_mode, m_wasAdded, and setAutoRemove().

Here is the call graph for this function:

TorrentFileGuard() [2/2]

TorrentFileGuard::TorrentFileGuard ( const QString &  path, const TorrentFileGuard::AutoDeleteMode  mode  )

private

Definition at line 51 of file torrentfileguard.cpp.

    : FileGuard {mode != Never ? path : QString()}
    , m_mode {mode}
    , m_wasAdded {false}
{
}

Member Function Documentation

autoDeleteMode()

TorrentFileGuard::AutoDeleteMode TorrentFileGuard::autoDeleteMode ( )

static

Definition at line 74 of file torrentfileguard.cpp.

{
    return autoDeleteModeSetting().get(AutoDeleteMode::Never);
}

References autoDeleteModeSetting().

Referenced by AddNewTorrentDialog::AddNewTorrentDialog(), OptionsDialog::loadOptions(), and AppController::preferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

autoDeleteModeSetting()

SettingValue< TorrentFileGuard::AutoDeleteMode > & TorrentFileGuard::autoDeleteModeSetting ( )

staticprivate

Definition at line 84 of file torrentfileguard.cpp.

{
    static SettingValue<AutoDeleteMode> setting {"Core/AutoDeleteAddedTorrentFile"};
    return setting;
}

Referenced by autoDeleteMode(), and setAutoDeleteMode().

Here is the caller graph for this function:

markAsAddedToSession()

void TorrentFileGuard::markAsAddedToSession

(

)

marks the torrent file as loaded (added) into the BitTorrent::Session

Definition at line 69 of file torrentfileguard.cpp.

{
    m_wasAdded = true;
}

References m_wasAdded.

setAutoDeleteMode()

void TorrentFileGuard::setAutoDeleteMode ( TorrentFileGuard::AutoDeleteMode  mode )

static

Definition at line 79 of file torrentfileguard.cpp.

{
    autoDeleteModeSetting() = mode;
}

References autoDeleteModeSetting().

Referenced by OptionsDialog::saveOptions(), and AppController::setPreferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

setAutoRemove()

void FileGuard::setAutoRemove

noexcept

Cancels or re-enables deferred file deletion.

Definition at line 44 of file torrentfileguard.cpp.

{
    m_remove = remove;
}

Referenced by ~TorrentFileGuard().

Here is the caller graph for this function:

Member Data Documentation

m_mode

AutoDeleteMode TorrentFileGuard::m_mode

private

Definition at line 81 of file torrentfileguard.h.

Referenced by ~TorrentFileGuard().

m_wasAdded

bool TorrentFileGuard::m_wasAdded

private

Definition at line 82 of file torrentfileguard.h.

Referenced by markAsAddedToSession(), and ~TorrentFileGuard().

---

The documentation for this class was generated from the following files:

• src/base/torrentfileguard.h
• src/base/torrentfileguard.cpp