SessionItemController Class Reference

Description

Provides subscribe/unsubscribe mechanism for any QObject to track time of life of SessionItem. Mainly intended for SessionItemWidget.

Definition at line 26 of file SessionItemController.h.

Inheritance diagram for SessionItemController:

Collaboration diagram for SessionItemController:

Public Types
using	callback_t = std::function< void(void)>

Public Member Functions
	SessionItemController (QObject *prt)
	~SessionItemController () override
SessionItem *	currentItem ()
void	setItem (SessionItem *item)
void	setSubscribeCallback (callback_t fun)
void	setUnsubscribeCallback (callback_t fun)
void	subscribe ()
	Subscribe parent to item's signals. More...
void	unsubscribe ()
	Fully unsubscribes the parent from listening item's signals. Controller stays active to track item destruction. More...

Private Member Functions
void	onControllerDestroy ()
void	onItemDestroy ()
void	subscribeParent ()
void	unsubscribeParent ()
	Calls additional callback on un. More...

Private Attributes
SessionItem *	m_item
bool	m_parent_subscribed
callback_t	m_subscribe_callback
callback_t	m_unsubscribe_callback

Member Typedef Documentation

callback_t

using SessionItemController::callback_t = std::function<void(void)>

Definition at line 29 of file SessionItemController.h.

Constructor & Destructor Documentation

SessionItemController()

SessionItemController::SessionItemController ( QObject *  prt )

explicit

Definition at line 18 of file SessionItemController.cpp.

    : QObject(prt)
    , m_item(nullptr)
    , m_parent_subscribed(false)
{
    ASSERT(parent());
}

~SessionItemController()

SessionItemController::~SessionItemController ( )

override

Definition at line 26 of file SessionItemController.cpp.

{
    onControllerDestroy();
}

References onControllerDestroy().

Here is the call graph for this function:

Member Function Documentation

currentItem()

SessionItem * SessionItemController::currentItem

(

)

Definition at line 48 of file SessionItemController.cpp.

{
    return m_item;
}

References m_item.

Referenced by SessionItemWidget::currentItem().

onControllerDestroy()

void SessionItemController::onControllerDestroy ( )

private

Definition at line 95 of file SessionItemController.cpp.

{
    if (m_item) {
        m_item->mapper()->unsubscribe(this);
        m_item->mapper()->unsubscribe(parent());
    }
}

References m_item, SessionItem::mapper(), and ModelMapper::unsubscribe().

Referenced by ~SessionItemController().

Here is the call graph for this function:

onItemDestroy()

void SessionItemController::onItemDestroy ( )

private

Definition at line 88 of file SessionItemController.cpp.

{
    if (m_parent_subscribed)
        unsubscribeParent();
    m_item = nullptr;
}

References m_item, m_parent_subscribed, and unsubscribeParent().

Referenced by setItem().

Here is the call graph for this function:

setItem()

void SessionItemController::setItem

(

SessionItem *

item

)

Definition at line 31 of file SessionItemController.cpp.

{
    if (m_item == item)
        return;
 
    if (m_item) {
        m_item->mapper()->unsubscribe(this);
        unsubscribe();
    }
 
    m_item = item;
    if (!m_item)
        return;
 
    m_item->mapper()->setOnItemDestroy([this](SessionItem*) { onItemDestroy(); }, this);
}

References m_item, SessionItem::mapper(), onItemDestroy(), ModelMapper::setOnItemDestroy(), unsubscribe(), and ModelMapper::unsubscribe().

Referenced by SessionItemWidget::setItem().

Here is the call graph for this function:

setSubscribeCallback()

void SessionItemController::setSubscribeCallback

(

callback_t

fun

)

Definition at line 53 of file SessionItemController.cpp.

{
    m_subscribe_callback = fun;
}

References m_subscribe_callback.

Referenced by SessionItemWidget::SessionItemWidget().

setUnsubscribeCallback()

void SessionItemController::setUnsubscribeCallback

(

callback_t

fun

)

Definition at line 58 of file SessionItemController.cpp.

{
    m_unsubscribe_callback = fun;
}

References m_unsubscribe_callback.

Referenced by SessionItemWidget::SessionItemWidget().

subscribe()

void SessionItemController::subscribe

(

)

Subscribe parent to item's signals.

Definition at line 65 of file SessionItemController.cpp.

{
    if (!m_item)
        return;
 
    if (!m_parent_subscribed)
        subscribeParent();
}

References m_item, m_parent_subscribed, and subscribeParent().

Referenced by SessionItemWidget::setItem(), and SessionItemWidget::showEvent().

Here is the call graph for this function:

subscribeParent()

void SessionItemController::subscribeParent ( )

private

Definition at line 103 of file SessionItemController.cpp.

{
    ASSERT(m_subscribe_callback);
    ASSERT(m_parent_subscribed == false);
    m_subscribe_callback();
    m_parent_subscribed = true;
}

References m_parent_subscribed, and m_subscribe_callback.

Referenced by subscribe().

unsubscribe()

void SessionItemController::unsubscribe

(

)

Fully unsubscribes the parent from listening item's signals. Controller stays active to track item destruction.

Definition at line 77 of file SessionItemController.cpp.

{
    if (!m_item)
        return;
 
    if (m_parent_subscribed)
        unsubscribeParent();
 
    m_item->mapper()->unsubscribe(parent());
}

References m_item, m_parent_subscribed, SessionItem::mapper(), ModelMapper::unsubscribe(), and unsubscribeParent().

Referenced by SessionItemWidget::hideEvent(), and setItem().

Here is the call graph for this function:

unsubscribeParent()

void SessionItemController::unsubscribeParent ( )

private

Calls additional callback on un.

Definition at line 113 of file SessionItemController.cpp.

{
    ASSERT(m_unsubscribe_callback);
    ASSERT(m_parent_subscribed == true);
    m_unsubscribe_callback();
    m_parent_subscribed = false;
}

References m_parent_subscribed, and m_unsubscribe_callback.

Referenced by onItemDestroy(), and unsubscribe().

Member Data Documentation

m_item

SessionItem* SessionItemController::m_item

private

Definition at line 52 of file SessionItemController.h.

Referenced by currentItem(), onControllerDestroy(), onItemDestroy(), setItem(), subscribe(), and unsubscribe().

m_parent_subscribed

bool SessionItemController::m_parent_subscribed

private

Definition at line 53 of file SessionItemController.h.

Referenced by onItemDestroy(), subscribe(), subscribeParent(), unsubscribe(), and unsubscribeParent().

m_subscribe_callback

callback_t SessionItemController::m_subscribe_callback

private

Definition at line 50 of file SessionItemController.h.

Referenced by setSubscribeCallback(), and subscribeParent().

m_unsubscribe_callback

callback_t SessionItemController::m_unsubscribe_callback

private

Definition at line 51 of file SessionItemController.h.

Referenced by setUnsubscribeCallback(), and unsubscribeParent().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/SessionItemController.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/SessionItemController.cpp