'encoding UTF-8  Do not remove or change this line!
'*************************************************************************
'
'  Licensed to the Apache Software Foundation (ASF) under one
'  or more contributor license agreements.  See the NOTICE file
'  distributed with this work for additional information
'  regarding copyright ownership.  The ASF licenses this file
'  to you under the Apache License, Version 2.0 (the
'  "License"); you may not use this file except in compliance
'  with the License.  You may obtain a copy of the License at
'  
'    http://www.apache.org/licenses/LICENSE-2.0
'  
'  Unless required by applicable law or agreed to in writing,
'  software distributed under the License is distributed on an
'  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
'  KIND, either express or implied.  See the License for the
'  specific language governing permissions and limitations
'  under the License.
'
'*************************************************************************
'*
'* short description :
'*
'\*******************************************************************
testcase tiToolsSpellcheckCheck_AlwaysIgnore
    
    Dim sExt as string
    
    Dim sWrongWord as String
    Dim sRightWord as string

    dim aWords(2) as string
    aWords() = getWordsForLanguage()

    sWrongWord = aWords(0)
    sRightWord = aWords(1)
    
    if(sWrongWord = "" OR sRightWord = "") then ' if any word is empty then the test should stop
        qaerrorlog "no spellcheck test for the langauges " + iSprache + " available."            
        goto endsub
    endif

    delete_word_from_dictionary(sWrongWord,"IgnoreAllList")

    if Ucase(gApplication) = "DRAW" then
        sExt = ".odg"
    else
        sExt = ".odp"
    endif

    Call hFileOpenLocally (gTesttoolpath + "graphics\required\input\recht_"+iSprache+sExt)

    sleep(1)

    ' Perform the test now:
    printlog "Call Tools->Spellcheck"
    ToolsSpellcheck    
    sleep(2)
    Kontext "Spellcheck"
    printlog "Click button 'Always ignore' on dialog."
    IgnoreAll.Click
    Sleep 2    

    ToolsOptions
    printlog "Select in category 'Languagesettings' entry 'Writing Aids.'"
    hToolsOptions ("LANGUAGESETTINGS","WRITINGAIDS")

    fSelectWithString(Benutzerwoerterbuch,"IgnoreAllList")

    Bearbeiten.Click

    Kontext "BenutzerwoerterbuchBearbeiten"
    if(Inhalt.getText <> sWrongWord) then
        warnlog " added word is not in dictionary: '" + Buch.getSelText + "'"
    else
        printlog " added word is in dictionary: '" + Buch.getSelText + "'"
    end if
    sleep 2

    printlog "Close dialog 'Edit Custom Dictionary'."
    BenutzerwoerterbuchBearbeiten.Close
    Kontext "ExtrasOptionenDlg"
    printlog "Close the Option dialog."
    ExtrasOptionenDlg.OK

    printlog "Close document"
    Call hCloseDocument

    ' remove the word again from the dictionary
    delete_word_from_dictionary(sWrongWord,"IgnoreAllList")

    kill (convertPath(gOfficePath+"user/work/"+"recht_"+iSprache+sExt))
endcase 'tiToolsSpellcheckCorrect

'------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
testcase tiToolsSpellcheckError
    if iSprache = 48 then
        qaerrorlog "This test is not adapted for polish, 48."
        got endsub
    endif
    Dim Fehler$
    Dim Sprachenname$
    Dim Dummy$
    Dim FehlerText$
    Dim i as integer

    printlog "New document"
    Call hNewDocument
    printlog "Selecting language case: " & iSprache
    select case iSprache
    case 01 : FehlerText$ = "Thatt is a failure test."                      : Fehler$ = "Thatt" : Sprachenname$ = "English (US)"
    case 34 : FehlerText$ = "Ezte es un chico muy importante."              : Fehler$ = "Ezte"  : Sprachenname$ = "Niederlaendisch"
    case 33 : FehlerText$ = "Ler nous faut donc un de temps pour examiner." : Fehler$ = "Ler"   : Sprachenname$ = "Franzoesisch"
    case 36 : FehlerText$ = "Boszniai americkai kontingens háromnegyedesek – mintegy négyezer katona – magyarországi telepítése egy éven belül megtörténhet" : Fehler$ = "tellepítésel"   : Sprachenname$ = "Ungarisch"
    case 39 : FehlerText$ = "Ringrarziamo per l'interessa mostrato a collaborare con la firma." : Fehler$ = "Ringrarziamo" : Sprachenname$ = "Italienisch"
    case 46 : FehlerText$ = "Detd varierar vad som behandlas och ur vilket perspektiv."         : Fehler$ = "Detd"         : Sprachenname$ = "Schwedisch"
    case 49 : FehlerText$ = "Diees ist ein Fehler."                         : Fehler$ = "Diees" : Sprachenname$ = "Deutsch"
    case 50 : FehlerText$ = "Toje napaka, ker manjka presledek."            : Fehler$ = "Toje" : Sprachenname$ = "Slovenš�?ina"
    case 55 : FehlerText$ = "Eesta poderia ser a resposta para suas preces?": Fehler$ = "Eesta" : Sprachenname$ = "Portugiesisch"
    case else :
        if bAsianLan then
            printlog "For the language  " + iSprache +" nothing is prepared yet, but is AsianLan, so OK :-) using english"
            FehlerText$ = "Thatt is a failure test."
            Fehler$ = "Thatt"
            Sprachenname$ = "English (US)"
            call hSetSpellHypLanguage
        else
            Warnlog "For the language  " + iSprache +" nothing is prepared yet: insert text here"
        end if
    end select
    printlog "Error Text taken for testing is: " & FehlerText$
    sleep 2

    printlog "Delete ignore word list"
    if (not wIgnorierenlisteLoeschen) then
        qaErrorLog "Can't get into Dictionary lists"
        goto endsub
    end if
    printlog "Setting doc language to english"
    ToolsOptions
    Kontext "ExtrasOptionenDlg"
    hToolsOptions("LANGUAGESETTINGS","Languages")
    Westlich.Select 34
    Kontext "ExtrasOptionenDlg"
    ExtrasOptionenDlg.OK
    printlog "Create 1 textbox with 1 spelling error (test replace always)"
    hTextrahmenErstellen (FehlerText$,30,30,90,40)

    hTypeKeys "<HOME>"
    printlog "Call 'Tools->Spellcheck->Check'"
    ToolsSpellcheck
    printlog "Spellcheck dialog has to come up, wrong word is selected."
    Kontext "Spellcheck"
    if Spellcheck.Exists then
        printlog "There has to be at least ONE suggestion."
        if (Suggestions.GetItemCount < 1) then
            printlog "If no suggestion avilable:"
            warnlog "   - no suggestion for the language: "+DictionaryLanguage.GetSelIndex+" '"+DictionaryLanguage.GetSelText+"' , press check button..."
            printlog "+ press button 'Check word'"
            Pruefen.click
            if (Suggestions.GetItemCount < 1) then
                warnlog " STILL no suggestions :-( errors will follow "
            else
                printlog "   - now suggestion for the language: "+DictionaryLanguage.GetSelIndex+" '"+DictionaryLanguage.GetSelText+"'" + Suggestions.GetItemCount
            end if
        end if
        Dummy$=Suggestions.GetItemText (1)
        printlog "Select first spellcheck suggestion (click it!)."
        Suggestions.Select (1)
        printlog "Check if textfield 'word' has changed to selected word."
        if (Suggestions.GetSelText <> Dummy$) Then
            Warnlog "Suggestion not used"
        else
            Printlog "Suggestion is used"
        end if
        sleep 1
        kontext "Spellcheck"
        printlog "click button 'Always replace'"
        ChangeAll.Click
        printlog "spellcheck dialog has to disappear and"
        printlog "There has to come up only one active: 'Spellcheck of entire document has been completed [OK]'"
        Kontext "Active"
        if Active.Exists(5) then
            Printlog "Message: Spellchecking has finished?: '" + active.gettext + "'"
            Active.OK
        else
            Printlog "'Change All' seems to have worked correctly."
            Kontext "Spellcheck"
            Spellcheck.Close
            Kontext "Active"
            if active.exists(5) then
                Printlog "Spellcheck dialog closed'" + active.gettext + "'"
                Active.OK
            else
                Printlog "Spellcheck dialog closed'"
            end if
        end if
    else
        Warnlog "  Error not recognized by the Spellchecker"
        if active.exists(5) then
            Kontext "Active"
            printlog "Message: spellchecking has finished?: '" + active.gettext + "'"
            Active.OK
        end if
    end if

    printlog "Close document"
    Call hCloseDocument

endcase 'tiToolsSpellcheckCorrect

'-------------------------------------------------------------------------------
testcase tiToolsSpellcheckCheck_Change

    Dim sExt as string
    Dim sWrongWord as String
    Dim sRightWord as string

    dim aWords(2) as string
    aWords() = getWordsForLanguage()

    sWrongWord = aWords(0)
    sRightWord = aWords(1)
    
    if(sWrongWord = "" OR sRightWord = "") then ' if any word is empty then the test should stop
        qaerrorlog "no spellcheck test for the langauges " + iSprache + " available."            
        goto endsub
    endif

    if Ucase(gApplication) = "DRAW" then
        sExt = ".odg"
    else
        sExt = ".odp"
    endif

    Call hFileOpenLocally (gTesttoolpath + "graphics\required\input\recht_"+iSprache+sExt)

    ' Perform the test now:
    printlog "Call Tools->Spellcheck"
    ToolsSpellcheck
    sleep(2)
    Kontext "Spellcheck"
    printlog "Click button 'Change' on dialog."
    Change.Click
    sleep(10)
    SpellcheckClose.click

    if Ucase(gApplication) = "DRAW" then
        Kontext "DocumentDraw"
        DocumentDraw.TypeKeys("<TAB>",true)
        DocumentDraw.TypeKeys("<SPACE>",true)        
    else
        Kontext "DocumentImpress"
        DocumentImpress.TypeKeys("<TAB>",true)
        DocumentImpress.TypeKeys("<SPACE>",true)
    endif

    EditSelectAll
    EditCopy
    
    dim s as string
    s = getClipBoard()

    printlog s

    if(Instr(s,sWrongWord) <> 0) then    	
        warnlog "word not changed. '" + s + "' contains still wrong word '" + sWrongWord + "'"
    else
        printlog "word changed."
    endif

    if(Instr(s,sRightWord) <> 0) then
        printlog "word changed."
    else
        warnlog "word not changed."
    endif
    
    printlog "Close document"
    Call hCloseDocument
    kill (convertPath(gOfficePath+"user/work/"+"recht_"+iSprache+sExt))

endcase 'tiToolsSpellcheckCheck_Change
'-------------------------------------------------------------------------------
testcase tiToolsSpellcheckCheck_ChangeAll

    Dim sExt as string
    Dim sRightWord as String
    Dim sWrongWord as string

    dim aWords(2) as string
    aWords() = getWordsForLanguage()

    sWrongWord = aWords(0)
    sRightWord = aWords(1)
    
    if(sWrongWord = "" OR sRightWord = "") then ' if any word is empty then the test should stop
        qaerrorlog "no spellcheck test for the langauges " + iSprache + " available."
        goto endsub
    endif

    'delete_word_from_dictionary(sWord,"IgnoreListAll")

    if Ucase(gApplication) = "DRAW" then
        sExt = ".odg"
    else
        sExt = ".odp"
    endif

    Call hFileOpenLocally (gTesttoolpath + "graphics\required\input\recht_"+iSprache+sExt)

    ' Perform the test now:
    printlog "Call Tools->Spellcheck"
    ToolsSpellcheck
    sleep(2)
    Kontext "Spellcheck"
    printlog "Click button 'Change' on dialog."
    ChangeAll.Click
    'TODO: check result beware of issue 110688
    Sleep 2

    SpellCheckClose.click

    printlog "Close document"
    Call hCloseDocument
    kill (convertPath(gOfficePath+"user/work/"+"recht_"+iSprache+sExt))

endcase 'tiToolsSpellcheckCheck_ChangeAll

'-------------------------------------------------------------------------------

function delete_all_added_words(aWords)

    'this function delete the words in sWords in all user dictionaries

    Dim iBookCounter as integer
    Dim iWordCounter as integer
    Dim iBooks as integer

    Printlog "Delete the given words from dictionaries."
    printlog "Call Tools->Options."
    ToolsOptions
    printlog "Select in category 'Languagesettings' entry 'Writing Aids.'"
    hToolsOptions ("LANGUAGESETTINGS","WRITINGAIDS")
    sleep 1
    Kontext "WRITINGAIDS"
    sleep 1
    printlog "select the first User-defined dictionaries and click EDIT"
    Benutzerwoerterbuch.select 1
    Bearbeiten.Click

    Kontext "BenutzerwoerterbuchBearbeiten"
    sleep 1
    printlog "Check every book, if it contains the words."
    iBooks = Buch.getItemCount
    for iBookCounter = 1 to iBooks
        Buch.select(iBookCounter)
        printlog "Items in Booklist: " & WordList.getItemCount
        for iWordCounter = 1 to uBound(aWords)
            Wort.setText aWords(iWordCounter)
            sleep 1
            if ((not neu.isEnabled) and Loeschen.isEnabled) then
                printlog "If it contains the word, press button 'delete'."
                Loeschen.click
                printlog "Added word WAS in dictionary: '" + Buch.getSelText + "' - '" + aWords(iWordCounter) + "'"
            end if
        next iWordCounter
    next iBookCounter
    printlog "Close dialog 'Edit Custom Dictionary.'"
    BenutzerwoerterbuchBearbeiten.Close
    sleep 1
    Kontext "ExtrasOptionenDlg"
    printlog "Press button 'OK' on dialog 'Writing Aids'."
    ExtrasOptionenDlg.OK
    
end function 'delete_all_added_words

'-------------------------------------------------------------------------------

function delete_word_from_dictionary(sWord as String, sDictionary as String)

    'this function delete the words in sWords in all user dictionaries

    Dim iBookCounter as integer
    Dim iWordCounter as integer
    Dim iBooks as integer

    Printlog "Delete the given word from dictionaries."
    printlog "Call Tools->Options."
    ToolsOptions
    printlog "Select in category 'Languagesettings' entry 'Writing Aids.'"
    hToolsOptions ("LANGUAGESETTINGS","WRITINGAIDS")
    sleep 1
    Kontext "WRITINGAIDS"
    sleep 1
    printlog "select the dictionary and click EDIT"

    fSelectWithString(Benutzerwoerterbuch,sDictionary)

    Bearbeiten.Click

    Kontext "BenutzerwoerterbuchBearbeiten"

    Wort.setText sWord
    sleep 1
    if ((not neu.isEnabled) and Loeschen.isEnabled) then
        printlog "If it contains the word, press button 'delete'."
        Loeschen.click
        printlog "Added word WAS in dictionary: '" + Buch.getSelText + "' - '" + sWord + "'"
    end if
        
    printlog "Close dialog 'Edit Custom Dictionary.'"
    BenutzerwoerterbuchBearbeiten.Close
    sleep 1
    Kontext "ExtrasOptionenDlg"
    printlog "Press button 'OK' on dialog 'Writing Aids'."
    ExtrasOptionenDlg.OK

end function 'delete_word_from_dictionary

'-------------------------------------------------------------------------------

function fSelectWithString(oControl as Object,sText as String)

    dim iCounter as Integer
    dim iNumberOfItems as Integer
    iNumberOfItems = oControl.getItemCount()

    for iCounter = 1 to iNumberOfItems
        oControl.select iCounter
        if( Instr(oControl.getSelText,sText) <> 0 ) then ' the correct entry is selected
            iCounter = iNumberOfItems ' stop the loop
        endif
    next

end function 'fSelectWithString

'-------------------------------------------------------------------------------

function getWordsForLanguage()

    dim sWrongWord as String
    dim sRightWord as String
    dim aWords(2) as String

    select case iSprache
        case 1 :
                sWrongWord = "documente"
                sRightWord = "document"
        case 31 :
                sWrongWord = "miejn"
                sRightWord = "mijn"
        case 33 :
                sWrongWord = "projjet"
                sRightWord = "projet"
        case 34 :
                sWrongWord = "lazsos"
                sRightWord = "lazos"
        case 36 :
                sWrongWord = "Bozniai"
                sRightWord = "Boszniai"
        case 39 :
                sWrongWord = "borrdo"
                sRightWord = "borro"
        case 46 :
                sWrongWord = "desa"
                sRightWord = "edas"
        case 48 :
                sWrongWord = "werrsji"
                sRightWord = "wersji"
        case 49 :
                sWrongWord = "Feehlern"
                sRightWord = "Fehlern"
        case 55 :
                sWrongWord = "Elle"
                sRightWord = "Elze"
        case else :
                sWrongWord = ""
                sRightWord = ""
    end select

    aWords(0) = sWrongWord
    aWords(1) = sRightWord

    getWordsForLanguage = aWords

end function 'getWordsForLanguage