ITabWidget Class Reference

This interface defines methods that should be implemented in widgets added to the main tab widget. More...

#include "ihavetabs.h"

Public Member Functions
virtual	~ITabWidget ()
virtual LC::TabClassInfo	GetTabClassInfo () const =0
	Returns the description of the tab class of this tab. More...
virtual QObject *	ParentMultiTabs ()=0
	Returns the pointer to the plugin this tab belongs to. More...
virtual void	Remove ()=0
	Requests to remove the tab. More...
virtual QToolBar *	GetToolBar () const =0
	Requests tab's toolbar. More...
virtual QList< QAction * >	GetTabBarContextMenuActions () const
	Returns the list of QActions for the context menu of the tabbar. More...
virtual QMap< QString, QList< QAction * > >	GetWindowMenus () const
	Returns the list of QActions to be inserted into global menu. More...
virtual void	TabMadeCurrent ()
	This method is called when this tab becomes active. More...
virtual void	TabLostCurrent ()
	This method is called when another tab becomes active. More...

Detailed Description

This interface defines methods that should be implemented in widgets added to the main tab widget.

A tab may also implement the following interfaces:

• IRecoverableTab if it makes sense to store the tab in tab session snapshots and IWk
• IWkFontSettable if the tab has a QtWebKit view and wishes to support configuring the fonts used in the view by the user.

See also

IRecoverableTab

IWkFontSettable

Definition at line 149 of file ihavetabs.h.

Constructor & Destructor Documentation

~ITabWidget()

virtual ITabWidget::~ITabWidget ( )

inlinevirtual

Definition at line 152 of file ihavetabs.h.

Member Function Documentation

GetTabBarContextMenuActions()

virtual QList<QAction*> ITabWidget::GetTabBarContextMenuActions ( ) const

inlinevirtual

Returns the list of QActions for the context menu of the tabbar.

These actions would be shown in the context menu that would pop-up when the user right-clicks this tab's button in the tabbar.

The default implementation returns an empty list.

Returns

The list of actions for tabbar context menu.

Definition at line 210 of file ihavetabs.h.

GetTabClassInfo()

virtual LC::TabClassInfo ITabWidget::GetTabClassInfo ( ) const

pure virtual

Returns the description of the tab class of this tab.

The entry must be the same as the one with the same TabClass_ returned from the IHaveTabs::GetTabClasses().

Returns

The tab class description.

See also

IHavetabs::GetTabClasses()

GetToolBar()

virtual QToolBar* ITabWidget::GetToolBar ( ) const

pure virtual

Requests tab's toolbar.

This method is called to obtain the tab toolbar. In current implementation, it would be shown on top of the LeechCraft's main window.

If the tab has no toolbar, 0 should be returned.

Returns

The tab's toolbar, or 0 if there is no toolbar.

GetWindowMenus()

virtual QMap<QString, QList<QAction*> > ITabWidget::GetWindowMenus ( ) const

inlinevirtual

Returns the list of QActions to be inserted into global menu.

For each key in the map (except special values, which would be defined later), the corresponding submenu would be created in LeechCraft global menu, and the corresponding list of actions would be inserted into that submenu. The submenus created would only be visible when this tab is active.

There are special values for the keys:

• "view" for the View menu.
• "tools" for the Tools menu.

The default implementation returns an empty map.

Returns

The map with keys identifying menus and values containing lists of actions to be inserted into corresponding menus.

Definition at line 233 of file ihavetabs.h.

ParentMultiTabs()

virtual QObject* ITabWidget::ParentMultiTabs ( )

pure virtual

Returns the pointer to the plugin this tab belongs to.

The returned object must implement IHaveTabs and must be the one that called IHaveTabs::addNewTab() with this tab as the parameter.

Returns

The pointer to the plugin that this tab belongs to.

Remove()

virtual void ITabWidget::Remove ( )

pure virtual

Requests to remove the tab.

This method is called by LeechCraft Core (or other plugins) when this tab should be closed, for example, when user clicked on the 'x' in the tab bar. The tab may ask the user if he really wants to close the tab, for example. The tab is free to ignore the close request (in this case nothing should be done at all) or accept it by emitting IHavetabs::removeTab() signal, passing this tab widget as its parameter.

TabLostCurrent()

virtual void ITabWidget::TabLostCurrent ( )

inlinevirtual

This method is called when another tab becomes active.

This method is called only if this tab was active before the other tab activates.

Definition at line 251 of file ihavetabs.h.

TabMadeCurrent()

virtual void ITabWidget::TabMadeCurrent ( )

inlinevirtual

This method is called when this tab becomes active.

The default implementation does nothing.

Definition at line 242 of file ihavetabs.h.

---

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

• /home/d34df00d/leechcraft/src/interfaces/ihavetabs.h