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

messagelist

  • MessageList
  • Core
  • Theme
  • Column
Classes | Public Member Functions | List of all members
MessageList::Core::Theme::Column Class Reference

#include <theme.h>

Classes

class  SharedRuntimeData
 

Public Member Functions

 Column ()
 
 Column (const Column &src)
 
 ~Column ()
 
void addGroupHeaderRow (Row *row)
 
void addMessageRow (Row *row)
 
bool containsTextItems () const
 
bool currentlyVisible () const
 
int currentWidth () const
 
void detach ()
 
const QList< Row * > & groupHeaderRows () const
 
void insertGroupHeaderRow (int idx, Row *row)
 
void insertMessageRow (int idx, Row *row)
 
bool isSenderOrReceiver () const
 
const QString & label () const
 
bool load (QDataStream &stream, int themeVersion)
 
const QList< Row * > & messageRows () const
 
SortOrder::MessageSorting messageSorting () const
 
const QString & pixmapName () const
 
void removeAllGroupHeaderRows ()
 
void removeAllMessageRows ()
 
void removeGroupHeaderRow (Row *row)
 
void removeMessageRow (Row *row)
 
void save (QDataStream &stream) const
 
void setCurrentlyVisible (bool currentlyVisible)
 
void setCurrentWidth (int currentWidth)
 
void setIsSenderOrReceiver (bool sor)
 
void setLabel (const QString &label)
 
void setMessageSorting (SortOrder::MessageSorting ms)
 
void setPixmapName (const QString &pixmapName)
 
void setVisibleByDefault (bool vbd)
 
bool visibleByDefault () const
 

Detailed Description

The Column class defines a view column available inside this theme.

Each Column has a list of Row items that define the visible rows.

Definition at line 564 of file theme.h.

Constructor & Destructor Documentation

Theme::Column::Column ( )
explicit

Create an empty column with default settings.

Definition at line 457 of file theme.cpp.

Theme::Column::Column ( const Column &  src)
explicit

Create an exact copy of the column src.

The shared runtime data is not copied (only a reference is added). If you need to create an independent clone then please use detach() after the construction.

Definition at line 466 of file theme.cpp.

Theme::Column::~Column ( )

Kill a column object.

Definition at line 485 of file theme.cpp.

Member Function Documentation

void MessageList::Core::Theme::Column::addGroupHeaderRow ( Row *  row)
inline

Appends a group header row to this theme.

The Theme takes the ownership of the Row pointer.

Definition at line 815 of file theme.h.

void MessageList::Core::Theme::Column::addMessageRow ( Row *  row)
inline

Appends a message row to this theme column.

The Theme takes the ownership of the Row pointer.

Definition at line 785 of file theme.h.

bool Theme::Column::containsTextItems ( ) const

Returns true if this column contains text items.

This is useful if you want to know if the column should just get its minimum allowable space or it should get more.

Definition at line 536 of file theme.cpp.

bool MessageList::Core::Theme::Column::currentlyVisible ( ) const
inline

Returns the current shared visibility state for this column.

This state is shared between all the instances of this theme.

Definition at line 745 of file theme.h.

int MessageList::Core::Theme::Column::currentWidth ( ) const
inline

Returns the current shared width setting for this column or -1 if the width is not specified and should be auto-determined.

This state is shared between all the instances of this theme.

Definition at line 760 of file theme.h.

void Theme::Column::detach ( )

Detaches the shared runtime data object and makes this object totally independent.

The shared runtime data is initialized to default values.

Definition at line 493 of file theme.cpp.

const QList< Row * >& MessageList::Core::Theme::Column::groupHeaderRows ( ) const
inline

Returns the list of rows visible in this column for a GroupHeaderItem.

Definition at line 803 of file theme.h.

void Theme::Column::insertGroupHeaderRow ( int  idx,
Row *  row 
)

Inserts a group header row to this theme column in the specified position.

The Theme takes the ownership of the Row pointer.

Definition at line 526 of file theme.cpp.

void Theme::Column::insertMessageRow ( int  idx,
Row *  row 
)

Inserts a message row to this theme column in the specified position.

The Theme takes the ownership of the Row pointer.

Definition at line 516 of file theme.cpp.

bool MessageList::Core::Theme::Column::isSenderOrReceiver ( ) const
inline

Returns true if this column is marked as "sender/receiver" and we should update its label on-the-fly.

Definition at line 699 of file theme.h.

const QString& MessageList::Core::Theme::Column::label ( ) const
inline

Returns the label set for this column.

Definition at line 674 of file theme.h.

bool Theme::Column::load ( QDataStream &  stream,
int  themeVersion 
)

Handles column loading (used by Theme::load())

Definition at line 585 of file theme.cpp.

const QList< Row * >& MessageList::Core::Theme::Column::messageRows ( ) const
inline

Returns the list of rows visible in this column for a MessageItem.

Definition at line 773 of file theme.h.

SortOrder::MessageSorting MessageList::Core::Theme::Column::messageSorting ( ) const
inline

Returns the sort order for messages that we should switch to when clicking on this column's header (if visible at all).

Definition at line 731 of file theme.h.

const QString& MessageList::Core::Theme::Column::pixmapName ( ) const
inline

Returns the icon's name (used in SmallIcon) set for this column.

Definition at line 686 of file theme.h.

void Theme::Column::removeAllGroupHeaderRows ( )

Removes all the group header rows from this column.

Definition at line 510 of file theme.cpp.

void Theme::Column::removeAllMessageRows ( )

Removes all the message rows from this column.

Definition at line 504 of file theme.cpp.

void MessageList::Core::Theme::Column::removeGroupHeaderRow ( Row *  row)
inline

Removes the specified group header row.

The row is NOT deleted.

Definition at line 827 of file theme.h.

void MessageList::Core::Theme::Column::removeMessageRow ( Row *  row)
inline

Removes the specified message row.

The row is NOT deleted.

Definition at line 797 of file theme.h.

void Theme::Column::save ( QDataStream &  stream) const

Handles column saving (used by Theme::save())

Definition at line 553 of file theme.cpp.

void MessageList::Core::Theme::Column::setCurrentlyVisible ( bool  currentlyVisible)
inline

Sets the current shared visibility state for this column.

This state is shared between all the instances of this theme.

Definition at line 752 of file theme.h.

void MessageList::Core::Theme::Column::setCurrentWidth ( int  currentWidth)
inline

Sets the current shared width setting for this column.

This state is shared between all the instances of this theme.

Definition at line 767 of file theme.h.

void MessageList::Core::Theme::Column::setIsSenderOrReceiver ( bool  sor)
inline

Marks this column as containing the "sender/receiver" field.

Such columns will have the label automatically updated.

Definition at line 706 of file theme.h.

void MessageList::Core::Theme::Column::setLabel ( const QString &  label)
inline

Sets the label for this column.

Definition at line 680 of file theme.h.

void MessageList::Core::Theme::Column::setMessageSorting ( SortOrder::MessageSorting  ms)
inline

Sets the sort order for messages that we should switch to when clicking on this column's header (if visible at all).

Definition at line 738 of file theme.h.

void MessageList::Core::Theme::Column::setPixmapName ( const QString &  pixmapName)
inline

Sets the icon's name (used in SmallIcon) for this column.

Definition at line 692 of file theme.h.

void MessageList::Core::Theme::Column::setVisibleByDefault ( bool  vbd)
inline

Sets the "visible by default" tag for this column.

Definition at line 718 of file theme.h.

bool MessageList::Core::Theme::Column::visibleByDefault ( ) const
inline

Returns true if this column has to be shown by default.

Definition at line 712 of file theme.h.


The documentation for this class was generated from the following files:
  • theme.h
  • theme.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