You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
316 lines
9.8 KiB
316 lines
9.8 KiB
/*
|
|
This file is part of KAddressBook.
|
|
Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
As a special exception, permission is given to link this program
|
|
with any edition of TQt, and distribute the resulting executable,
|
|
without including the source code for TQt in the source distribution.
|
|
*/
|
|
|
|
#ifndef KADDRESSBOOKVIEW_H
|
|
#define KADDRESSBOOKVIEW_H
|
|
|
|
#define KAB_VIEW_PLUGIN_VERSION 1
|
|
|
|
#include <tqstringlist.h>
|
|
#include <tqwidget.h>
|
|
|
|
#include <kabc/field.h>
|
|
#include <klibloader.h>
|
|
#include <tdepimmacros.h>
|
|
|
|
#include "filter.h"
|
|
#include "viewconfigurewidget.h"
|
|
|
|
class TDEConfig;
|
|
class KXMLGUIClient;
|
|
|
|
class TQDropEvent;
|
|
|
|
namespace KAB { class Core; }
|
|
namespace KABC { class AddressBook; }
|
|
|
|
/**
|
|
Base class for all views in kaddressbook. This class implements
|
|
all the common methods needed to provide a view to the user.
|
|
|
|
To implement a specific view (table, card, etc), just inherit from
|
|
this class and implement all the pure virtuals.
|
|
|
|
@author Mike Pilone <mpilone@slac.com>
|
|
*/
|
|
class KDE_EXPORT KAddressBookView : public TQWidget
|
|
{
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
enum DefaultFilterType { None = 0, Active = 1, Specific = 2 };
|
|
|
|
KAddressBookView( KAB::Core *core, TQWidget *parent, const char *name );
|
|
virtual ~KAddressBookView();
|
|
|
|
/**
|
|
Must be overloaded in subclasses. Should return a list of
|
|
all the uids of selected contacts.
|
|
*/
|
|
virtual TQStringList selectedUids() = 0;
|
|
|
|
/**
|
|
Called whenever this view should read the config. This can be used
|
|
as a sign that the config has changed, therefore the view should
|
|
assume the worst and rebuild itself if necessary. For example,
|
|
in a table view this method may be called when the user adds or
|
|
removes columns from the view.
|
|
|
|
If overloaded in the subclass, do not forget to call super class's
|
|
method.
|
|
|
|
@param config The TDEConfig object to read from. The group will already
|
|
be set, so do not change the group.
|
|
*/
|
|
virtual void readConfig( TDEConfig *config );
|
|
|
|
/**
|
|
Called whenever this view should write the config. The view should not
|
|
write out information handled by the application, such as which fields
|
|
are visible. The view should only write out information specific
|
|
to itself (i.e.: All information in the ViewConfigWidget)
|
|
|
|
If overloaded in the subclass, do not forget to call the super class's
|
|
method.
|
|
*/
|
|
// The TDEConfig object is unused so we do not document it
|
|
// else doxygen will complain.
|
|
virtual void writeConfig( TDEConfig * );
|
|
|
|
/**
|
|
Returns a TQString with all the selected email addresses concatenated
|
|
together with a ',' seperator.
|
|
*/
|
|
virtual TQString selectedEmails();
|
|
|
|
/**
|
|
Return the type of the view: Icon, Table, etc. Please make sure that
|
|
this is the same value that ViewWrapper::type() will return for your
|
|
view.
|
|
*/
|
|
virtual TQString type() const = 0;
|
|
|
|
/**
|
|
Returns a list of the fields that should be displayed. The list
|
|
is composed of the fields proper names (ie: Home Address), so
|
|
the view may need to translate them in order to get the
|
|
value from the addressee.
|
|
|
|
This list is generated from the config file, so it is advisable to call
|
|
this method whenever a readConfig() is called in order to get the newest
|
|
list of fields.
|
|
*/
|
|
KABC::Field::List fields() const;
|
|
|
|
/**
|
|
Sets the active filter. This filter will be used for filtering
|
|
the list of addressees to display. The view will <b>not</b>
|
|
automatically refresh itself, so in most cases you will want to call
|
|
KAddressBookView::refresh() after this method.
|
|
*/
|
|
void setFilter( const Filter& );
|
|
|
|
/**
|
|
@return The default filter type selection. If the selection
|
|
is SpecificFilter, the name of the filter can be retrieved with
|
|
defaultFilterName()
|
|
*/
|
|
DefaultFilterType defaultFilterType() const;
|
|
|
|
/**
|
|
@return The name of the default filter. This string is
|
|
only valid if defaultFilterType() is returning SpecificFilter.
|
|
*/
|
|
const TQString &defaultFilterName() const;
|
|
|
|
/**
|
|
@return The Core object.
|
|
*/
|
|
KAB::Core *core() const;
|
|
|
|
/**
|
|
@return The current sort field.
|
|
*/
|
|
virtual KABC::Field *sortField() const = 0;
|
|
|
|
virtual void scrollUp() = 0;
|
|
virtual void scrollDown() = 0;
|
|
|
|
public slots:
|
|
/**
|
|
Must be overloaded in subclasses to refresh the view.
|
|
Refreshing includes updating the view to ensure that only items
|
|
in the document are visible. If <i>uid</i> is valid, only the
|
|
addressee with uid needs to be refreshed. This is an optimization
|
|
only.
|
|
*/
|
|
virtual void refresh( const TQString &uid = TQString() ) = 0;
|
|
|
|
/**
|
|
This method must be overloaded in subclasses. Select (highlight)
|
|
the addressee matching <i>uid</i>. If uid
|
|
is equal to TQString(), then all addressees should be selected.
|
|
*/
|
|
virtual void setSelected( const TQString &uid = TQString(), bool selected = true ) = 0;
|
|
|
|
/**
|
|
Selects the first contact in the view.
|
|
*/
|
|
virtual void setFirstSelected( bool selected = true ) = 0;
|
|
|
|
/**
|
|
Call this slot to popup a rmb menu.
|
|
|
|
@param point The position where the menu shall appear.
|
|
*/
|
|
void popup( const TQPoint &point );
|
|
|
|
signals:
|
|
/**
|
|
This signal should be emitted by a subclass whenever an addressee
|
|
is modified.
|
|
*/
|
|
void modified();
|
|
|
|
/**
|
|
This signal should be emitted by a subclass whenever an addressee
|
|
is selected. Selected means that the addressee was given the focus.
|
|
Some widgets may call this 'highlighted'. The view is responsible for
|
|
emitting this signal multiple times if multiple items are selected,
|
|
with the last item selected being the last emit.
|
|
|
|
@param uid The uid of the selected addressee.
|
|
|
|
@see KListView
|
|
*/
|
|
void selected( const TQString &uid );
|
|
|
|
/**
|
|
This signal should be emitted by a subclass whenever an addressee
|
|
is executed. This is defined by the KDE system wide config, but it
|
|
either means single or doubleclicked.
|
|
|
|
@param uid The uid of the selected addressee
|
|
|
|
@see KListView
|
|
*/
|
|
void executed( const TQString &uid );
|
|
|
|
/**
|
|
This signal is emitted whenever a user attempts to start a drag
|
|
in the view. The slot connected to this signal would usually want
|
|
to create a TQDragObject.
|
|
*/
|
|
void startDrag();
|
|
|
|
/**
|
|
This signal is emitted whenever the user drops something on the
|
|
view. The individual view should handle checking if the item is
|
|
droppable (ie: if it is a vcard).
|
|
*/
|
|
void dropped( TQDropEvent* );
|
|
|
|
/**
|
|
This signal is emitted whenever the sort field changed.
|
|
*/
|
|
void sortFieldChanged();
|
|
|
|
/**
|
|
Emitted whenever the view fields changed.
|
|
*/
|
|
void viewFieldsChanged();
|
|
|
|
protected:
|
|
/**
|
|
Returns a list of the addressees that should be displayed. This method
|
|
should always be used by the subclass to get a list of addressees. This
|
|
method internally takes many factors into account, including the current
|
|
filter.
|
|
*/
|
|
KABC::Addressee::List addressees();
|
|
|
|
/**
|
|
This method returns the widget that should be used as the parent for
|
|
all view components. By using this widget as the parent and not
|
|
'this', the view subclass has the option of placing other widgets
|
|
around the view (ie: search fields, etc). Do not delete this widget!
|
|
*/
|
|
TQWidget *viewWidget();
|
|
|
|
private slots:
|
|
void updateView();
|
|
|
|
private:
|
|
void initGUI();
|
|
|
|
DefaultFilterType mDefaultFilterType;
|
|
Filter mFilter;
|
|
TQString mDefaultFilterName;
|
|
KAB::Core *mCore;
|
|
KABC::Field::List mFieldList;
|
|
|
|
TQWidget *mViewWidget;
|
|
};
|
|
|
|
class KDE_EXPORT ViewFactory : public KLibFactory
|
|
{
|
|
public:
|
|
virtual KAddressBookView *view( KAB::Core *core, TQWidget *parent,
|
|
const char *name = 0 ) = 0;
|
|
/**
|
|
@return The type of the view. This is normally a small one word
|
|
string (ie: Table, Icon, Tree, etc).
|
|
*/
|
|
virtual TQString type() const = 0;
|
|
|
|
/**
|
|
@return The description of the view. This should be a 3 to
|
|
4 line string (don't actually use return characters in the string)
|
|
describing the features offered by the view.
|
|
*/
|
|
virtual TQString description() const = 0;
|
|
|
|
/**
|
|
Creates a config dialog for the view type. The default
|
|
implementation will return a ViewConfigDialog. This default
|
|
dialog will allow the user to set the visible fields only. If
|
|
you need more config options (as most views will), this method
|
|
can be overloaded to return your sublcass of ViewConfigDialog.
|
|
If this method is over loaded the base classes method should
|
|
<B>not</B> be called.
|
|
*/
|
|
virtual ViewConfigureWidget *configureWidget( KABC::AddressBook *ab,
|
|
TQWidget *parent,
|
|
const char *name = 0 );
|
|
|
|
protected:
|
|
virtual TQObject* createObject( TQObject*, const char*, const char*,
|
|
const TQStringList & )
|
|
{
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
#endif
|