testautomation/framework/optional/includes/ole_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: ole_tools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-16 12:18:15 $
  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 : thorsten.bosbach@sun.com
  35 '*
  36 '* short description : global-level-1-test -> insert all OLE-Objects out of OLE-dialog into all doc-types
  37 '*
  38 '\******************************************************************************
  39
  40 sub hReopenDoc
  41     'Only for bughandling if closing an OLE object fails
  42     Warnlog "Cannot release Chart Object -> #107005#?"
  43     hCloseDocument()
  44     'if Active.Exists ( 1 ) then Active.TypeKeys "<RIGHT><ENTER>"
  45     hNewDocument()
  46 end sub
  47
  48 '*******************************************************************************
  49
  50 sub hOleSelektieren ( xStart%, yStart%, xEnde%, yEnde% )
  51     WL_TB_ZF_Auswahl
  52     select case gApplication
  53     case "CALC"     :Kontext "DocumentCalc"
  54         DocumentCalc.MouseDown xStart%, yStart%
  55         DocumentCalc.MouseMove xEnde%, yEnde%
  56         DocumentCalc.MouseUp xEnde%, yEnde%
  57         wait 200
  58     case "DRAW"     :Kontext "DocumentDraw"
  59         DocumentDraw.MouseDown xStart%, yStart%
  60         DocumentDraw.MouseMove xEnde%, yEnde%
  61         DocumentDraw.MouseUp xEnde%, yEnde%
  62     case "WRITER"   :Kontext "DocumentWriter"
  63         DocumentWriter.MouseDown xStart%, yStart%
  64         DocumentWriter.MouseMove xEnde%, yEnde%
  65         DocumentWriter.MouseUp xEnde%, yEnde%
  66     case "IMPRESS"  :Kontext "DocumentImpress"
  67         DocumentImpress.MouseDown xStart%, yStart%
  68         DocumentImpress.MouseMove xEnde%, yEnde%
  69         DocumentImpress.MouseUp xEnde%, yEnde%
  70     case "MATH"     :Kontext "DocumentMath"
  71         DocumentMath.MouseDown xStart%, yStart%
  72         DocumentMath.MouseMove xEnde%, yEnde%
  73         DocumentMath.MouseUp xEnde%, yEnde%
  74     case "MASTERDOCUMENT":Kontext "DocumentMasterDoc"
  75         DocumentMasterDoc.MouseDown xStart%, yStart%
  76         DocumentMasterDoc.MouseMove xEnde%, yEnde%
  77         DocumentMasterDoc.MouseUp xEnde%, yEnde%
  78     end select
  79 end sub
  80
  81 '*******************************************************************************
  82
  83 sub hSetToStandardView ( DieApp$ )
  84     select case DieApp$
  85     case "WRITER"
  86     gApplication = "WRITER"
  87         Call hNewDocument
  88         Kontext "DocumentWriter"
  89     case "MASTERDOCUMENT"
  90     gApplication = "MASTERDOCUMENT"
  91         Call hNewDocument
  92         Kontext "DocumentMasterDoc"
  93     end select
  94     ViewZoom
  95     Kontext "Massstab"
  96     Optimal.Check
  97     Massstab.ok()
  98     Call hCloseDocument
  99 end sub
 100
 101 '*******************************************************************************
 102
 103 sub SendEscape(optional iTimes as Integer)
 104     dim i as Integer
 105     const ICWAIT as Integer = 1
 106
 107     if IsMissing( iTimes ) then
 108         iTimes = 1
 109     endif
 110     '///+press [ESCAPE]
 111     printlog( "    - send <ESCAPE> keystroke to document" )
 112     select case gApplication
 113     case "WRITER"
 114     Kontext "DocumentWriter"
 115         for i = 1 to iTimes
 116             sleep( ICWAIT )
 117             DocumentWriter.TypeKeys( "<ESCAPE>" , 1 , TRUE )
 118         next i
 119     case "CALC"
 120     Kontext "DocumentCalc"
 121         for i = 1 to iTimes
 122             sleep( ICWAIT )
 123             DocumentCalc.TypeKeys( "<ESCAPE>" , 1 , TRUE )
 124         next i
 125     case "MASTERDOCUMENT"
 126     Kontext "DocumentMasterDoc"
 127         for i = 1 to iTimes
 128             sleep( ICWAIT )
 129             DocumentMasterDoc.TypeKeys( "<ESCAPE>" , 1 , TRUE )
 130         next i
 131     case "DRAW"
 132     Kontext "DocumentDraw"
 133         for i = 1 to iTimes
 134             sleep( ICWAIT )
 135             DocumentDraw.TypeKeys( "<ESCAPE>" , 1 , TRUE )
 136         next i
 137     case "IMPRESS"
 138     Kontext "DocumentImpress"
 139         for i = 1 to iTimes
 140             sleep( ICWAIT )
 141             DocumentImpress.TypeKeys( "<ESCAPE>" , 1 , TRUE )
 142         next i
 143     case else
 144     warnlog( "Invalid gApplication: " & gApplication )
 145     end select
 146 end sub
 147
 148 '*******************************************************************************
 149
 150 sub DisableNavigator()
 151     printlog( "    - disable the navigator in globaldoc/writer" )
 152     select case gApplication
 153     case "MASTERDOCUMENT" : Kontext "NavigatorGlobalDoc"
 154         if NavigatorGlobalDoc.Exists() then
 155             ViewNavigator
 156         endif
 157     case "WRITER"    : Kontext "NavigatorWriter"
 158         if NavigatorWriter.Exists() then
 159             ViewNavigator
 160         endif
 161     end select
 162     sleep( 1)
 163 end sub
 164
 165 '*******************************************************************************
 166
 167 sub UncheckAutoFileExtension()
 168     '///+uncheck automatic file extension, if checked
 169     Kontext "SpeichernDlg"
 170     if SpeichernDlg.exists(5) then
 171         if AutomatischeDateinamenserweiterung.Exists() then
 172             printlog("l1_ole_tools::UncheckAutoFileExtension  - unchecking automatic file extension" )
 173             If AutomatischeDateinamenserweiterung.IsChecked() then
 174                 AutomatischeDateinamenserweiterung.Uncheck()
 175             endif
 176         else
 177             QAErrorLog ( "OBSOLETE: l1_ole_tools::UncheckAutoFileExtension Checkbox 'Automatic Filename Extension' unavailable" )
 178         endif
 179     else
 180         warnlog( "l1_ole_tools::UncheckAutoFileExtension SaveAs Dialog not open." )
 181     endif
 182 end sub
 183
 184 '*******************************************************************************
 185
 186 function getExtension( optional sExtension as string ) as string
 187     qaerrorlog( "getExtension is outdated. Use hGetSuffix( ... ) instead" )
 188     printlog("l1_ole_ttols::getExtension:: - define the expected file extension" )
 189     select case gApplication
 190     case "WRITER"
 191     sExtension = ".sxw"
 192     case "DRAW"
 193     sExtension = ".sxd"
 194     case "IMPRESS"
 195     sExtension = ".sxi"
 196     case "CALC"
 197     sExtension = ".sxc"
 198     case "MATH"
 199     sExtension = ".sxm"
 200     case "MASTERDOCUMENT"
 201     sExtension = ".sgl"
 202     case else
 203     warnlog( "Invalid gApplication: " & gApplication )
 204     end select
 205     getExtension = sExtension
 206 end function
 207
 208 '*******************************************************************************
 209
 210 sub OLESetFocus()
 211     '///+activate the OLE-Object with a doubleclick
 212     const ICWAIT as Integer = 10
 213     PrintLog "    - set focus to OLE object (edit mode)"
 214     select case gApplication
 215     case "WRITER"
 216     printlog "      Select and deselect " + gApplication
 217         Kontext "DocumentWriter"
 218         DocumentWriter.TypeKeys("<F6>"           , 4 , TRUE )
 219         DocumentWriter.TypeKeys("<DOWN>"         , 3 , TRUE )
 220         DocumentWriter.TypeKeys("<RIGHT>"        , 1 , TRUE )
 221         DocumentWriter.TypeKeys("<MOD1 RETURN>"  , 1 , TRUE )
 222         DocumentWriter.TypeKeys("<TAB>"          , 1 , TRUE )
 223         DocumentWriter.TypeKeys("<RETURN>"       , 1 , TRUE )
 224         'DocumentWriter.MouseDoubleClick ( 50, 50 )
 225         sleep( ICWAIT )
 226         call SendEscape( 3 ) '(to close the float as well)
 227     case "IMPRESS"
 228     printlog "      Select and deselect " + gApplication
 229         Kontext "DocumentImpress"
 230         DocumentImpress.MouseDoubleClick ( 50, 50 )
 231         sleep( ICWAIT )
 232     case "CALC"
 233     printlog "      Select and deselect " + gApplication
 234         Kontext "DocumentCalc"
 235         DocumentCalc.TypeKeys( "<F6>"            , 5 , TRUE )
 236         DocumentCalc.TypeKeys( "<DOWN>"          , 3 , TRUE )
 237         DocumentCalc.TypeKeys( "<MOD1 RETURN>"   , 1 , TRUE )
 238         DocumentCalc.TypeKeys( "<RETURN>"        , 1 , TRUE )
 239         'gMouseClick ( 20, 20 )
 240         'DocumentCalc.MouseDoubleClick ( 20, 20 )
 241         sleep( ICWAIT )
 242         call SendEscape( 3 ) '(to close the float as well)
 243     case "MASTERDOCUMENT"
 244     printlog "      Select and deselect " + gApplication
 245         Kontext "DocumentMasterDoc"
 246         DocumentMasterDoc.MouseDown( 50 , 50 , 1 )
 247         DocumentMasterDoc.MouseUp( 50 , 50 , 1 )
 248         hUseAsyncSlot( "EditObjectEdit" )
 249         sleep( ICWAIT )
 250             case else
 251     warnlog( "Invalid gApplication: " & gApplication )
 252
 253     end select
 254 end sub
 255
 256 '*******************************************************************************
 257
 258 sub OLESetFocus2()
 259     '///+activate the OLE-Object with a doubleclick
 260     'default waitstate
 261     const ICWAIT as Integer = 1
 262     PrintLog "    - set focus to OLE object (edit mode)"
 263     select case gApplication
 264     case "WRITER"
 265     Kontext "DocumentWriter"
 266         try
 267             FormatObject
 268             Kontext ' This is by intention, do not change!
 269             active.SetPage TabType
 270             Kontext "TabType"
 271             TabType.Cancel()
 272             hUseAsyncSlot( "EditObjectEdit" )
 273         catch
 274             warnlog "Can't activate object"
 275         endcatch
 276         sleep( ICWAIT * 2 )
 277         gMouseClick ( 5 , 5 ) 'out of edit mode
 278         gMouseClick ( 5 , 5 ) 'remove focus
 279     case "DRAW"
 280     Kontext "DocumentDraw"
 281         if OLEApp = "MATH" then
 282             DocumentDraw.MouseDoubleClick ( 45, 46 )
 283         else
 284             DocumentDraw.MouseDoubleClick ( 50, 45 )
 285         end if
 286         sleep( ICWAIT * 5 )
 287         gMouseClick ( 1 , 1 )
 288     case "IMPRESS"
 289     Kontext "DocumentImpress"
 290         printlog( "    - using accessibility shortcuts for objecthandling" )
 291         printlog( "      (select, activate and release object)" )
 292         DocumentImpress.TypeKeys( "<F6>" , 5 , TRUE )
 293         DocumentImpress.TypeKeys( "<TAB><RETURN>" )
 294         sleep( ICWAIT * 2 )
 295         call SendEscape()
 296     case "CALC"
 297     Kontext "DocumentCalc"
 298         printlog( "    - using accessibility shortcuts for objecthandling" )
 299         printlog( "      (select, activate and release object)" )
 300         DocumentCalc.TypeKeys( "<F6>"          , 5 , TRUE )
 301         DocumentCalc.TypeKeys( "<DOWN>"        , 3 , TRUE )
 302         DocumentCalc.TypeKeys( "<RIGHT>"       , 1 , TRUE )
 303         DocumentCalc.TypeKeys( "<MOD1 RETURN>" , 1 , TRUE )
 304         DocumentCalc.TypeKeys( "<RETURN>"      , 1 , TRUE )
 305         sleep( ICWAIT * 2 )
 306         call sendEscape()
 307     case "MASTERDOCUMENT"
 308     Kontext "DocumentMasterDoc"
 309         try
 310             FormatObject
 311             sleep( ICWAIT )
 312             Kontext ' This is by intention, do not change!
 313             Active.SetPage TabType
 314             Kontext "TabType"
 315             TabType.Cancel
 316             hUseAsyncSlot( "EditObjectEdit" )
 317         catch
 318             qaerrorlog( "The object is not selected after reload." )
 319         endcatch
 320         Sleep( ICWAIT )
 321         Kontext "DocumentMasterDoc"
 322         DocumentMasterDoc.MouseDoubleClick ( 1 , 1 )
 323     case else
 324     warnlog( "Invalid gApplication: " & gApplication )
 325
 326     end select
 327 end sub
 328
 329 '*******************************************************************************
 330
 331 sub OLESetFocus3()
 332     'TODO: Get rid of as many mousemovements as possible
 333     'default waitstate
 334     const ICWAIT as Integer = 1
 335     printlog( "    - set focus to OLE object (edit mode)" )
 336     select case gApplication
 337     case "WRITER"
 338     Kontext "DocumentWriter"
 339         try
 340             FormatObject
 341             sleep( ICWAIT )
 342             Kontext ' This is by intention, do not change!
 343             active.SetPage TabType
 344             Kontext "TabType"
 345             TabType.Cancel
 346             hUseAsyncSlot( "EditObjectEdit" )
 347         catch
 348             warnlog "Can't activate object"
 349         endcatch
 350         sleep( ICWAIT * 5 )
 351         gMouseClick ( 1, 1 )
 352     case "DRAW"
 353     Kontext "DocumentDraw"
 354         DocumentDraw.TypeKeys ("<Tab>")
 355         DocumentDraw.MouseDoubleClick ( 50, 50 )
 356         sleep( ICWAIT * 5 )
 357         gMouseClick ( 1, 1 )
 358     case "IMPRESS"
 359     Kontext "DocumentImpress"
 360         printlog( "    - Using accessibility-shortcuts to manipulate object")
 361         DocumentImpress.TypeKeys( "<TAB>" )
 362         sleep( ICWAIT )
 363         DocumentImpress.TypeKeys( "<SHIFT RETURN>" )
 364         call SendEscape( 3 )
 365     case "MASTERDOCUMENT"
 366     Kontext "DocumentMasterDoc"
 367         try
 368             FormatObject
 369             sleep( ICWAIT )
 370             Kontext ' This is by intention, do not change!
 371             active.SetPage( TabType )
 372             Kontext "TabType"
 373             TabType.Cancel()
 374             hUseAsyncSlot( "EditObjectEdit" )
 375         catch
 376             qaerrorlog( "The object is not selected after reload." )
 377         endcatch
 378         sleep( ICWAIT * 5 )
 379         call SendEscape( 2 )
 380     case else
 381     warnlog( "Invalid gApplication: " & gApplication )
 382
 383     end select
 384 end sub
 385
 386 '*******************************************************************************
 387
 388 sub OLERemoveFocus
 389     '///+Deselect OLE object
 390     printlog( "Remove focus from OLE object for " & gApplication )
 391     select case gApplication
 392     case "WRITER"    : call SendEscape( 2 )
 393     case "MASTERDOCUMENT" : Kontext "DocumentMasterDoc"
 394         DocumentMasterDoc.MouseDoubleClick ( 1, 1 )
 395     case "IMPRESS"   : gMouseClick ( 5, 99 )
 396     case "CALC"      : Kontext "DocumentCalc"
 397         call SendEscape()
 398     end select
 399 end sub
 400
 401 '*******************************************************************************
 402
 403 sub ClosePresentationFloat()
 404     gApplication = "IMPRESS"
 405     '///+Open a new document
 406     printlog( "Open a new document" )
 407     hNewDocument
 408     'use the tiny little hammer to kill the presentation float
 409     printlog( "Reset the application (which closes the presentation toolbar)" )
 410     resetapplication
 411     '///+Open a new document
 412     printlog( "Open a new document" )
 413     hNewDocument
 414     '///+Look if the presentation toolbar is visible, if yes->warning
 415     Kontext "CommonTaskbar"
 416     try
 417         printlog( "Try to click a button on the presentation toolbar" )
 418         Seiteduplizieren.click()
 419         warnlog( "The presentation toolbar is open" )
 420     catch
 421         printlog( "Button is unavailable. Good" )
 422     endcatch
 423     '///+Close the document
 424     printlog( "Close the document" )
 425     hCloseDocument
 426     gApplication = "WRITER" ' reset, just in case...
 427 end sub
 428
 429
 430 '*******************************************************************************
 431
 432 function hStepThroughChartWizard() as boolean
 433
 434
 435     '///<h3>Step through the Chart Wizard leaving all defaults</h3>
 436     '///<i>This functin just steps through the Chart Wizard using the
 437     '///+ &quot;Next...&quot; button on each page. It will not change any
 438     '///+ values under way. The Wizard is closed using the &quot;Finish&quot;
 439     '///+ button.</i><br><br>
 440
 441     '///<u>Parameter(s):</u><br>
 442     '///<ol>
 443     '///+<li>No input parameters</li>
 444     '///</ol>
 445
 446
 447     '///<u>Returns:</u><br>
 448     '///<ol>
 449     '///+<li>Errorcondition (Boolean)</li>
 450     '///<ul>
 451     '///+<li>TRUE: Wizard finished without errors</li>
 452     '///+<li>FALSE: Wizard did not open</li>
 453     '///+<li>In case of problems you need to perfom recovery yourself</li>
 454     '///</ul>
 455     '///</ol>
 456
 457     const CFN = "hStepThroughChartWizard::"
 458     printlog( CFN & "Enter" )
 459     dim brc as boolean 'a multi purpose boolean returnvalue
 460
 461     '///<u>Description:</u>
 462     '///<ul>
 463     '///+<li>Verify that the Chart Wizard is open</li>
 464     Kontext "ChartWizard"
 465     if ( not chartWizard.exists( 1 ) ) then
 466
 467         warnlog( CFN & "Chart Wizard not open within reasonable time" )
 468         hStepThroughChartWizard() = false
 469
 470     else
 471
 472         '///+<li>Click &quot;Next&quot; on the first page of the Chart wizard</li>
 473         Kontext "ChartWizard"
 474         GoNext.Click()
 475
 476         '///+<li>Click &quot;Next&quot; on the second page of the Chart wizard</li>
 477         Kontext "ChartWizard"
 478         GoNext.Click()
 479
 480         '///+<li>Click &quot;Next&quot; on the third page of the Chart wizard</li>
 481         Kontext "ChartWizard"
 482         GoNext.Click()
 483
 484         '///+<li>Click &quot;Finish&quot; on the fourth page of the Chart wizard</li>
 485         Kontext "ChartWizard"
 486         ChartWizard.ok()
 487         Sleep( 3 )
 488
 489     endif
 490
 491     '///+<li>Verify that the Chart Wizard is closed</li>
 492     kontext "ChartWizard"
 493     if ( ChartWizard.exists( 1 ) ) then
 494         warnlog( CFN & "Chart Wizard is still open" )
 495     endif
 496
 497     '///</ul>
 498
 499     printlog( CFN & "Exit" )
 500
 501     hStepThroughChartWizard() = true
 502
 503 end function
 504