summaryrefslogtreecommitdiffabout
path: root/kaddressbook/viewconfigurewidget.h
blob: e3b9b12365d068888cca63f1e1aa928d1daf9d8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*                                                                      
    This file is part of KAddressBook.                                  
    Copyright (c) 2002 Mike Pilone <mpilone@slac.com>                   
                                                                        
    This program is free software; you can rremovePageedistribute 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.           
                                                                        
    As a special exception, permission is given to link this program    
    with any edition of Qt, and distribute the resulting executable,    
    without including the source code for Qt in the source distribution.
*/                                                                      

#ifndef VIEWCONFIGUREWIDGET_H
#define VIEWCONFIGUREWIDGET_H



#include "configurewidget.h"

class Q3VBox;

#include <kdialogbase.h>
#include <qpixmap.h>

class KJanusWidget;
class QString;
class ViewConfigureFieldsPage;
class ViewConfigureFilterPage;
class ViewConfigureDialog;
/**
  This widget is the base class for all view configuration widgets. The 
  author of a view may wish to inherit from this widget and add config pages
  that add custom config options. The default implementation of this widget
  is to show a page with the select fields widget. For simple views this may
  be sufficient.
*/
class ViewConfigureWidget : public ConfigureWidget
{
  Q_OBJECT
    
  public:
    ViewConfigureWidget( KABC::AddressBook *ab, QWidget *parent, const char *name = 0 );
    virtual ~ViewConfigureWidget();
    
    /**
      Reads the configuration from the config object and sets the values
      in the GUI. If this method is overloaded, be sure to call the base
      class's method.

      Do not change the group of the config object in this method.
     */
    virtual void restoreSettings( KConfig *config );
    
    /**
      Writes the configuration from the GUI to the config object. If this
      method is overloaded, be sure to call the base class's method.

      Do not change the group of the config object in this method.
     */
    virtual void saveSettings( KConfig *config );
 

    /**
      Use this method to add new pages to the widget.
     */
    Q3VBox *addPage( const QString &item, const QString &header = QString::null,
                    const QPixmap &pixmap = QPixmap() );
                                                            
  private:
    KJanusWidget *mMainWidget;    

    ViewConfigureFieldsPage *mFieldsPage;
    ViewConfigureFilterPage *mFilterPage;
};

class ViewConfigureDialog : public KDialogBase
{
  Q_OBJECT

  public:
    ViewConfigureDialog( ViewConfigureWidget *wdg, const QString &viewName,
                         QWidget *parent, const char *name = 0 );
    ~ViewConfigureDialog();

    void restoreSettings( KConfig* );
    void saveSettings( KConfig* );
    void setWidget( ViewConfigureWidget *wdg );
  protected slots:
    void slotHelp();

  private:
    ViewConfigureWidget *mConfigWidget;
};

#endif