libkdepim/uistatesaver.h

   1 /*
   2     Copyright (c) 2008 Volker Krause <vkrause@kde.org>
   3
   4     This library is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU Library General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or (at your
   7     option) any later version.
   8
   9     This library is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  12     License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to the
  16     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17     02110-1301, USA.
  18 */
  19
  20 #ifndef UISTATESAVER_H
  21 #define UISTATESAVER_H
  22
  23 #include "kdepim_export.h"
  24
  25 class QWidget;
  26 class KConfigGroup;
  27
  28 namespace KPIM {
  29
  30 /**
  31  * @short Methods to save and restore the UI state of an application.
  32  *
  33  * This namespace provides methods that automatically save and restore
  34  * the state of various UI elements to/from a configuration group.
  35  *
  36  * The following widgets are supported so far:
  37  * - QSplitter
  38  * - QTabWidget
  39  * - QTreeView
  40  * - QComboBox
  41  *
  42  * @note The widgets need to have set an objectName, otherwise they are ignored
  43  *       on processing.
  44  *
  45  * @author Volker Krause <vkrause@kde.org>
  46  * @since 4.5
  47  */
  48 namespace UiStateSaver {
  49
  50   /**
  51    * Saves the state of @p widget and all its sub-widgets to @p config.
  52    * @param widget The top-level widget which state should be saved.
  53    * @param config The config group the settings should be written to.
  54    */
  55   KDEPIM_EXPORT void saveState( QWidget* widget, KConfigGroup &config );
  56
  57   /**
  58    * Restores the UI state of @p widget and all its sub-widgets from @p config.
  59    * @param widget The top-level widget which state should be restored.
  60    * @param config The config gorup the settings should be read from.
  61    */
  62   KDEPIM_EXPORT void restoreState( QWidget *widget, const KConfigGroup &config );
  63 }
  64
  65 }
  66
  67 #endif