• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

messagelist

  • MessageList
  • Core
  • Widget
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
MessageList::Core::Widget Class Reference

#include <widgetbase.h>

Inheritance diagram for MessageList::Core::Widget:
Inheritance graph
[legend]

Public Slots

void changeQuicksearchVisibility (bool)
 
void populateStatusFilterCombo ()
 

Signals

void fullSearchRequest ()
 
void statusMessage (const QString &message)
 

Public Member Functions

 Widget (QWidget *parent)
 
 ~Widget ()
 
void aggregationMenuAboutToShow (KMenu *menu)
 
QString currentFilterSearchString () const
 
Akonadi::MessageStatus currentFilterStatus () const
 
QString currentFilterTagId () const
 
Core::MessageItem * currentMessageItem () const
 
void focusQuickSearch ()
 
bool isThreaded () const
 
KLineEdit * quickSearch () const
 
void saveCurrentSelection ()
 
bool searchEditHasFocus () const
 
bool selectionEmpty () const
 
void setCurrentFolder (const Akonadi::Collection &collection)
 
void setStorageModel (StorageModel *storageModel, PreSelectionMode preSelectionMode=PreSelectLastSelected)
 
void sortOrderMenuAboutToShow (KMenu *menu)
 
StorageModel * storageModel () const
 
void themeMenuAboutToShow (KMenu *menu)
 
View * view () const
 

Protected Slots

void aggregationMenuAboutToShow ()
 
void aggregationsChanged ()
 
void aggregationSelected (bool)
 
void configureThemes ()
 
void groupSortDirectionSelected (QAction *action)
 
void groupSortingSelected (QAction *action)
 
void messageSortDirectionSelected (QAction *action)
 
void messageSortingSelected (QAction *action)
 
void resetFilter ()
 
void searchEditClearButtonClicked ()
 
void searchEditTextEdited (const QString &text)
 
void searchTimerFired ()
 
void setPrivateSortOrderForStorage ()
 
void slotLockSearchClicked (bool b)
 
void slotViewHeaderSectionClicked (int logicalIndex)
 
void sortOrderMenuAboutToShow ()
 
void statusSelected (int index)
 
void themeMenuAboutToShow ()
 
void themesChanged ()
 
void themeSelected (bool)
 

Protected Member Functions

virtual void fillMessageTagCombo (KComboBox *combo)
 
void tagIdSelected (const QVariant &data)
 
virtual void viewDragEnterEvent (QDragEnterEvent *e)
 
virtual void viewDragMoveEvent (QDragMoveEvent *e)
 
virtual void viewDropEvent (QDropEvent *e)
 
virtual void viewGroupHeaderContextPopupRequest (GroupHeaderItem *group, const QPoint &globalPos)
 
virtual void viewJobBatchStarted ()
 
virtual void viewJobBatchTerminated ()
 
virtual void viewMessageActivated (MessageItem *msg)
 
virtual void viewMessageListContextPopupRequest (const QList< MessageItem * > &selectedItems, const QPoint &globalPos)
 
virtual void viewMessageSelected (MessageItem *msg)
 
virtual void viewMessageStatusChangeRequest (MessageItem *msg, const Akonadi::MessageStatus &set, const Akonadi::MessageStatus &clear)
 
virtual void viewSelectionChanged ()
 
virtual void viewStartDragRequest ()
 

Detailed Description

Provides a widget which has the messagelist and the most important helper widgets, like the search line and the comboboxes for changing status filtering, aggregation etc.

Definition at line 60 of file widgetbase.h.

Constructor & Destructor Documentation

Widget::Widget ( QWidget *  parent)
explicit

Definition at line 123 of file widgetbase.cpp.

Widget::~Widget ( )

Definition at line 206 of file widgetbase.cpp.

Member Function Documentation

void Widget::aggregationMenuAboutToShow ( KMenu *  menu)

Definition at line 562 of file widgetbase.cpp.

void Widget::aggregationMenuAboutToShow ( )
protectedslot

Definition at line 554 of file widgetbase.cpp.

void Widget::aggregationsChanged ( )
protectedslot

This is called by Manager when the option sets stored within have changed.

Definition at line 983 of file widgetbase.cpp.

void Widget::aggregationSelected ( bool  )
protectedslot

Definition at line 596 of file widgetbase.cpp.

void Widget::changeQuicksearchVisibility ( bool  show)
slot

Shows or hides the quicksearch field, the filter combobox and the toolbutton for advanced search.

Definition at line 221 of file widgetbase.cpp.

void Widget::configureThemes ( )
protectedslot

Definition at line 515 of file widgetbase.cpp.

QString Widget::currentFilterSearchString ( ) const

Returns the search term in the current quicksearch field.

Definition at line 328 of file widgetbase.cpp.

Akonadi::MessageStatus Widget::currentFilterStatus ( ) const

Returns the Akonadi::MessageStatus in the current quicksearch field.

Definition at line 321 of file widgetbase.cpp.

QString Widget::currentFilterTagId ( ) const

Returns the id of the MessageItem::Tag currently set in the quicksearch field.

Definition at line 335 of file widgetbase.cpp.

MessageItem * Widget::currentMessageItem ( ) const

Returns the current MessageItem in the current folder.

May return 0 if there is no current message or no current folder.

Definition at line 316 of file widgetbase.cpp.

void Widget::fillMessageTagCombo ( KComboBox *  combo)
protectedvirtual

Called when the "Message Status/Tag" filter menu is opened by the user.

You may override this function in order to add some "custom tag" entries to the menu. The entries should be placed in a QActionGroup which should be returned to the caller. The QAction objects associated to the entries should have the string id of the tag set as data() and the tag icon set as icon(). The default implementation does nothing.

Reimplemented in MessageList::Widget.

Definition at line 991 of file widgetbase.cpp.

void Widget::focusQuickSearch ( )

Sets the focus on the quick search line of the currently active tab.

Definition at line 1168 of file widgetbase.cpp.

void MessageList::Core::Widget::fullSearchRequest ( )
signal

Emitted when a full search is requested.

void Widget::groupSortDirectionSelected ( QAction *  action)
protectedslot

Definition at line 890 of file widgetbase.cpp.

void Widget::groupSortingSelected ( QAction *  action)
protectedslot

Definition at line 866 of file widgetbase.cpp.

bool Widget::isThreaded ( ) const

Returns true if the current Aggregation is threaded, false otherwise (or if there is no current Aggregation).

Definition at line 1173 of file widgetbase.cpp.

void Widget::messageSortDirectionSelected ( QAction *  action)
protectedslot

Definition at line 842 of file widgetbase.cpp.

void Widget::messageSortingSelected ( QAction *  action)
protectedslot

Definition at line 818 of file widgetbase.cpp.

void Widget::populateStatusFilterCombo ( )
slot

This is called to setup the status filter's KComboBox.

Definition at line 299 of file widgetbase.cpp.

KLineEdit * Widget::quickSearch ( ) const

Returns the search line of this widget.

Can be 0 if the quick search is disabled in the global configuration.

Definition at line 450 of file widgetbase.cpp.

void Widget::resetFilter ( )
protectedslot

Definition at line 914 of file widgetbase.cpp.

void Widget::saveCurrentSelection ( )

Definition at line 398 of file widgetbase.cpp.

void Widget::searchEditClearButtonClicked ( )
protectedslot

Definition at line 1107 of file widgetbase.cpp.

bool Widget::searchEditHasFocus ( ) const

Definition at line 1188 of file widgetbase.cpp.

void Widget::searchEditTextEdited ( const QString &  text)
protectedslot

Definition at line 1064 of file widgetbase.cpp.

void Widget::searchTimerFired ( )
protectedslot

Definition at line 1085 of file widgetbase.cpp.

bool Widget::selectionEmpty ( ) const

Fast function that determines if the selection is empty.

Definition at line 1178 of file widgetbase.cpp.

void Widget::setCurrentFolder ( const Akonadi::Collection &  collection)

Sets the current folder.

Definition at line 1183 of file widgetbase.cpp.

void Widget::setPrivateSortOrderForStorage ( )
protectedslot

Definition at line 504 of file widgetbase.cpp.

void Widget::setStorageModel ( StorageModel *  storageModel,
PreSelectionMode  preSelectionMode = PreSelectLastSelected 
)

Sets the storage model for this Widget.

Pre-selection is the action of automatically selecting a message just after the folder has finished loading. See Model::setStorageModel() for more information.

Definition at line 412 of file widgetbase.cpp.

void Widget::slotLockSearchClicked ( bool  b)
protectedslot

Definition at line 923 of file widgetbase.cpp.

void Widget::slotViewHeaderSectionClicked ( int  logicalIndex)
protectedslot

Handles header section clicks switching the Aggregation MessageSorting on-the-fly.

Definition at line 935 of file widgetbase.cpp.

void Widget::sortOrderMenuAboutToShow ( KMenu *  menu)

Definition at line 646 of file widgetbase.cpp.

void Widget::sortOrderMenuAboutToShow ( )
protectedslot

Definition at line 635 of file widgetbase.cpp.

void MessageList::Core::Widget::statusMessage ( const QString &  message)
signal

Notify the outside when updating the status bar with a message could be useful.

void Widget::statusSelected ( int  index)
protectedslot

Definition at line 1024 of file widgetbase.cpp.

StorageModel * Widget::storageModel ( ) const

Returns the StorageModel currently set.

May be 0.

Definition at line 445 of file widgetbase.cpp.

void Widget::tagIdSelected ( const QVariant &  data)
protected

Definition at line 996 of file widgetbase.cpp.

void Widget::themeMenuAboutToShow ( KMenu *  menu)

Definition at line 471 of file widgetbase.cpp.

void Widget::themeMenuAboutToShow ( )
protectedslot

Definition at line 460 of file widgetbase.cpp.

void Widget::themesChanged ( )
protectedslot

This is called by Manager when the option sets stored within have changed.

Definition at line 976 of file widgetbase.cpp.

void Widget::themeSelected ( bool  )
protectedslot

Definition at line 522 of file widgetbase.cpp.

View * Widget::view ( ) const

Returns the View attached to this Widget.

Never 0.

Definition at line 455 of file widgetbase.cpp.

void Widget::viewDragEnterEvent ( QDragEnterEvent *  e)
protectedvirtual

This is called by View when a drag enter event is received.

Reimplemented in MessageList::Widget.

Definition at line 1137 of file widgetbase.cpp.

void Widget::viewDragMoveEvent ( QDragMoveEvent *  e)
protectedvirtual

This is called by View when a drag move event is received.

Reimplemented in MessageList::Widget.

Definition at line 1141 of file widgetbase.cpp.

void Widget::viewDropEvent ( QDropEvent *  e)
protectedvirtual

This is called by View when a drop event is received.

Reimplemented in MessageList::Widget.

Definition at line 1145 of file widgetbase.cpp.

void Widget::viewGroupHeaderContextPopupRequest ( GroupHeaderItem *  group,
const QPoint &  globalPos 
)
protectedvirtual

This is called by View when a group header is right clicked.

Reimplemented in MessageList::Widget.

Definition at line 1133 of file widgetbase.cpp.

void Widget::viewJobBatchStarted ( )
protectedvirtual

This is called by View to signal a start of a (possibly lengthy) job batch.

Definition at line 1153 of file widgetbase.cpp.

void Widget::viewJobBatchTerminated ( )
protectedvirtual

This is called by View to signal the end of a (possibly lengthy) job batch.

Definition at line 1157 of file widgetbase.cpp.

void Widget::viewMessageActivated ( MessageItem *  msg)
protectedvirtual

This is called by View when a message is double-clicked or activated by other input means.

Reimplemented in MessageList::Widget.

Definition at line 1121 of file widgetbase.cpp.

void Widget::viewMessageListContextPopupRequest ( const QList< MessageItem * > &  selectedItems,
const QPoint &  globalPos 
)
protectedvirtual

This is called by View when a message is right clicked.

Reimplemented in MessageList::Widget.

Definition at line 1129 of file widgetbase.cpp.

void Widget::viewMessageSelected ( MessageItem *  msg)
protectedvirtual

This is called by View when a message is single-clicked (thus selected and made current)

Reimplemented in MessageList::Widget.

Definition at line 1117 of file widgetbase.cpp.

void Widget::viewMessageStatusChangeRequest ( MessageItem *  msg,
const Akonadi::MessageStatus &  set,
const Akonadi::MessageStatus &  clear 
)
protectedvirtual

This is called by View when a message item is manipulated by the user in a way that it's status should change.

(e.g, by clicking on a status icon, for example).

Reimplemented in MessageList::Widget.

Definition at line 1161 of file widgetbase.cpp.

void Widget::viewSelectionChanged ( )
protectedvirtual

This is called by View when selection changes.

Reimplemented in MessageList::Widget.

Definition at line 1125 of file widgetbase.cpp.

void Widget::viewStartDragRequest ( )
protectedvirtual

This is called by View when a drag can possibly be started.

Reimplemented in MessageList::Widget.

Definition at line 1149 of file widgetbase.cpp.


The documentation for this class was generated from the following files:
  • widgetbase.h
  • widgetbase.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:32 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

messagelist

Skip menu "messagelist"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal