svtools/qa/complex/ConfigItems/helper/HistoryOptTest.hxx

   1 /*************************************************************************
   2  *
   3  *  OpenOffice.org - a multi-platform office productivity suite
   4  *
   5  *  $RCSfile: HistoryOptTest.hxx,v $
   6  *
   7  *  $Revision: 1.1.4.2 $
   8  *
   9  *  last change: $Author: as $ $Date: 2008/03/19 11:09:24 $
  10  *
  11  *  The Contents of this file are made available subject to
  12  *  the terms of GNU Lesser General Public License Version 2.1.
  13  *
  14  *
  15  *    GNU Lesser General Public License Version 2.1
  16  *    =============================================
  17  *    Copyright 2005 by Sun Microsystems, Inc.
  18  *    901 San Antonio Road, Palo Alto, CA 94303, USA
  19  *
  20  *    This library is free software; you can redistribute it and/or
  21  *    modify it under the terms of the GNU Lesser General Public
  22  *    License version 2.1, as published by the Free Software Foundation.
  23  *
  24  *    This library is distributed in the hope that it will be useful,
  25  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  27  *    Lesser General Public License for more details.
  28  *
  29  *    You should have received a copy of the GNU Lesser General Public
  30  *    License along with this library; if not, write to the Free Software
  31  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  32  *    MA  02111-1307  USA
  33  *
  34  ************************************************************************/
  35
  36 #ifndef  SVTOOLS_HISTORYOPTTEST_HXX
  37 #define  SVTOOLS_HISTORYOPTTEST_HXX
  38
  39 #include <com/sun/star/container/XNameAccess.hpp>
  40 #include <svtools/historyoptions.hxx>
  41
  42 namespace css = ::com::sun::star;
  43
  44 class HistoryOptTest
  45 {
  46     public:
  47
  48         HistoryOptTest();
  49         virtual ~HistoryOptTest();
  50
  51         //---------------------------------------------------------------------
  52         /** unit test of picklist */
  53         void checkPicklist();
  54
  55         //---------------------------------------------------------------------
  56         /** unit test of URL list */
  57         void checkURLHistory();
  58
  59         //---------------------------------------------------------------------
  60         /** unit test of Help bookmarks */
  61         void checkHelpBookmarks();
  62
  63     private:
  64
  65         //---------------------------------------------------------------------
  66         /** test every well known history list in the same way.
  67          *  Only the count of created and tested items can be defined from outside
  68          *  e.g. usefull for stress tests.
  69          *
  70          *  @param  eHistory
  71          *          specify the history list for testing.
  72          *
  73          *  @param  nMaxItems
  74          *          max count of new created and tested history items.
  75          */
  76         void impl_testHistory(EHistoryType eHistory ,
  77                               ::sal_Int32  nMaxItems);
  78
  79         //---------------------------------------------------------------------
  80         /** try to clear the whole list and check the results.
  81          *  If list could not be cleared successfully an exception is thrown.
  82          */
  83         void impl_clearList();
  84
  85         //---------------------------------------------------------------------
  86         /** define a new size for the current list and check the results.
  87          *  Note: The given size must match against the defined constraints.
  88          *  That must be checked before this method is called.
  89          *
  90          *  @param  nSize
  91          *          the new size.
  92          */
  93         void impl_setSize(::sal_Int32 nSize);
  94
  95         //---------------------------------------------------------------------
  96         /** create a new item (means it's properties using a special schema using the
  97          *  item id).
  98          *
  99          *  Note: This method does not check if creation was successfully.
 100          *        Therefore exists more specialized method impl_existsItem()
 101          *        and impl_existsItemAtPosition().
 102          *
 103          *  @param  nItem
 104          *          id of the item
 105          */
 106         void impl_appendItem(::sal_Int32 nItem);
 107
 108         //---------------------------------------------------------------------
 109         /** check if an entry for given item id realy exists (in memory and xcu file).
 110          *
 111          *  @param  nItem
 112          *          id of the item
 113          *
 114          *  @return true if item exists - false otherwise.
 115          */
 116         ::sal_Bool impl_existsItem(::sal_Int32 nItem);
 117
 118         //---------------------------------------------------------------------
 119         /** check if an entry for given item id realy exists (in memory and xcu file).
 120          *  Further it checks if the requested item is placed at the also specified
 121          *  position inside history list.
 122          *
 123          *  @param  nItem
 124          *          id of the item
 125          *
 126          *  @param  nIndex
 127          *          expected position of item inside history list.
 128          *
 129          *  @return true if item exists at right position - false otherwise.
 130          */
 131         ::sal_Bool impl_existsItemAtIndex(::sal_Int32 nItem ,
 132                                           ::sal_Int32 nIndex);
 133
 134         //---------------------------------------------------------------------
 135         /** create an URL suitable for the given item id.
 136          *
 137          *  @param  nItem
 138          *          id of the item
 139          *
 140          *  @return the new created URL.
 141          */
 142         ::rtl::OUString impl_createItemURL(::sal_Int32 nItem);
 143
 144         //---------------------------------------------------------------------
 145         /** create a title suitable for the given item id.
 146          *
 147          *  @param  nItem
 148          *          id of the item
 149          *
 150          *  @return the new created title.
 151          */
 152         ::rtl::OUString impl_createItemTitle(::sal_Int32 nItem);
 153
 154         //---------------------------------------------------------------------
 155         /** create a password suitable for the given item id.
 156          *
 157          *  @param  nItem
 158          *          id of the item
 159          *
 160          *  @return the new created password.
 161          */
 162         ::rtl::OUString impl_createItemPassword(::sal_Int32 nItem);
 163
 164         //---------------------------------------------------------------------
 165         /** returns direct access to the item list inside histories.xcu
 166          *  suitable for the current defined list type (m_eList).
 167          *
 168          *  @return reference to the item list configuration
 169          */
 170         css::uno::Reference< css::container::XNameAccess > impl_getItemList();
 171
 172         //---------------------------------------------------------------------
 173         /** returns direct access to the order list inside histories.xcu
 174          *  suitable for the current defined list type (m_eList).
 175          *
 176          *  @return reference to the order list configuration
 177          */
 178         css::uno::Reference< css::container::XNameAccess > impl_getOrderList();
 179
 180         //---------------------------------------------------------------------
 181         /** returns direct access to the history list inside histories.xcu
 182          *  suitable for the current defined list type (m_eList).
 183          *
 184          *  @return reference to the history list configuration
 185          */
 186         css::uno::Reference< css::container::XNameAccess > impl_getNewHistory();
 187
 188         //---------------------------------------------------------------------
 189         /** returns direct access to the history config inside common.xcu
 190          *  suitable for the current defined list type (m_eList).
 191          *
 192          *  @return reference to the history configuration
 193          */
 194         css::uno::Reference< css::container::XNameAccess > impl_getOldHistory();
 195
 196     private:
 197
 198         // the config item which should be tested here
 199         SvtHistoryOptions m_aConfigItem;
 200
 201         // defines the special list for testing (picklist, history or url list)
 202         EHistoryType m_eList;
 203
 204         // underlying configuration of the tested config items for cross over checks
 205         css::uno::Reference< css::container::XNameAccess > m_xHistoriesXCU;
 206
 207         // underlying configuration of the tested config items for cross over checks
 208         css::uno::Reference< css::container::XNameAccess > m_xCommonXCU;
 209 };
 210
 211 #endif // #ifndef  SVTOOLS_HISTORYOPTTEST_HXX