testautomation/framework/tools/includes/filedlg_tools.inc

   1 'encoding UTF-8  Do not remove or change this line!
   2 '**************************************************************************
   3 '* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 '*
   5 '* Copyright 2008 by Sun Microsystems, Inc.
   6 '*
   7 '* OpenOffice.org - a multi-platform office productivity suite
   8 '*
   9 '* $RCSfile: filedlg_tools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-16 12:19:05 $
  14 '*
  15 '* This file is part of OpenOffice.org.
  16 '*
  17 '* OpenOffice.org is free software: you can redistribute it and/or modify
  18 '* it under the terms of the GNU Lesser General Public License version 3
  19 '* only, as published by the Free Software Foundation.
  20 '*
  21 '* OpenOffice.org is distributed in the hope that it will be useful,
  22 '* but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 '* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 '* GNU Lesser General Public License version 3 for more details
  25 '* (a copy is included in the LICENSE file that accompanied this code).
  26 '*
  27 '* You should have received a copy of the GNU Lesser General Public License
  28 '* version 3 along with OpenOffice.org.  If not, see
  29 '* <http://www.openoffice.org/license.html>
  30 '* for a copy of the LGPLv3 License.
  31 '*
  32 '/******************************************************************************
  33 '*
  34 '*  owner : joerg.skottke@sun.com
  35 '*
  36 '*  short description : Special tasks on filedialogs
  37 '*
  38 '\******************************************************************************
  39
  40 function hFileOpenMultiSelect( iArray() as integer ) as integer
  41
  42
  43     '///<h3>Multiselect files with the fileopen dialog</h3>
  44     '///<i>This function uses keyboard navigation to select a number of files
  45     '///+ (multiselection).</i><br>
  46     '///<u>Starting point</u>: FileOpen dialog has context, workdirectory is
  47     '///+ open<br><br>
  48
  49     '///<u>Input value(s):</u><br>
  50     '///<ol>
  51     '///+<li>Array (integer)</li>
  52     '///<ul>
  53     '///+<li>if ( array( n ) = 1 ) select the file at pos n, starting at n = 1</li>
  54     '///+<li>Any other value: Do not select, preferably preset with 0!</li>
  55     '///+<li>The size of the array must less or equal the number of files in the filepicker<br>
  56     '///+ Array( 0 ) is ignored</li>
  57     '///</ul>
  58     '///</ol>
  59
  60     '///<u>Return Value:</u><br>
  61     '///<ol>
  62     '///+<li>Number of selected files (integer)</li>
  63     '///<ul>
  64     '///+<li>= 0: any error</li>
  65     '///+<li>&gt; 0: Number of selected files (Sum of Array( n ) = 1)</li>
  66     '///</ul>
  67     '///</ol>
  68
  69     const CFN = "hFileOpenMultiSelect::"
  70     dim brc as boolean 'a multi purpose boolean returnvalue
  71
  72     dim iArraySize as integer
  73     dim iCurrentFile as integer
  74     dim cCurrentFile as string
  75     dim iSelectedFilesCount as integer
  76         iSelectedFilesCount = 0
  77
  78     '///<u>Description:</u>
  79     '///<ul>
  80     '///+<li>Get the size of the array</li>
  81     iArraySize = ubound( iArray() )
  82
  83     '///+<li>Get the number of items from the filepicker</li>
  84     kontext "OeffnenDlg"
  85     iFileCount = Dateiauswahl.getItemCount()
  86
  87     '///+<li>Verify that the array size is equal or less the number of files<br>
  88     '///+ Exit with rc = 0 on error</li>
  89     ' Note: This can be done because it is quite simply expected that we know the
  90     '       number of files within the workdirectory. Take one input-dir.
  91     if ( iFileCount < iArraySize ) then
  92         qaerrorlog( CFN & "Array too large. Array must be <= file count" )
  93         printlog( CFN & "Files present in dialog: " & iFileCount )
  94         printlog( CFN & "Arraysize..............: " & iArraySize )
  95         hFileOpenMultiSelect() = 0
  96         exit function
  97     endif
  98
  99     '///+<li>Select the first object in the filelist</li>
 100     kontext "OeffnenDlg"
 101     DateiAuswahl.typeKeys( "<HOME>" )
 102
 103     '///+<li>Run through the filelist and select all items that are marked in the array</li>
 104     '///<ul>
 105     for iCurrentFile = 1 to iArraySize
 106
 107         '///+<li>Select a file with CTRL+SPACE</li>
 108         if ( iArray( iCurrentFile ) = 1 ) then
 109             DateiAuswahl.typeKeys( "<MOD1 SPACE>" )
 110             cCurrentFile = DateiAuswahl.getSelText() ' does this work?
 111             printlog( CFN & "Select: " & cCurrentFile & " at pos: " & iCurrentFile )
 112             iSelectedFilesCount = iSelectedFilesCount + 1
 113         endif
 114
 115         '///+<li>Move one down with CTRL key pressed</li>
 116         DateiAuswahl.typekeys( "<MOD1 DOWN>" )
 117
 118     next iCurrentFile
 119     '///</ul>
 120     '///</ul>
 121     hFileOpenMultiSelect() = 0
 122
 123 end function