NAVFoundation.UIUtils.axi

PROGRAM_NAME='NAVFoundation.UIUtils'

/*
 _   _                       _          ___     __
| \ | | ___  _ __ __ _  __ _| |_ ___   / \ \   / /
|  \| |/ _ \| '__/ _` |/ _` | __/ _ \ / _ \ \ / /
| |\  | (_) | | | (_| | (_| | ||  __// ___ \ V /
|_| \_|\___/|_|  \__, |\__,_|\__\___/_/   \_\_/
                 |___/

MIT License

Copyright (c) 2023 Norgate AV Services Limited

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#IF_NOT_DEFINED __NAV_FOUNDATION_UIUTILS__
#DEFINE __NAV_FOUNDATION_UIUTILS__ 'NAVFoundation.UIUtils'

#include 'NAVFoundation.Core.axi'


DEFINE_CONSTANT


DEFINE_TYPE

////////////////////////////////////////////////////////////
// Button
////////////////////////////////////////////////////////////
struct _NAVUIButton {
    char Label[NAV_MAX_CHARS]
    char Bitmap[NAV_MAX_CHARS]
    integer Icon
    integer Enabled
    integer Hidden
    integer Channel
    integer Address
}


////////////////////////////////////////////////////////////
// UI State
////////////////////////////////////////////////////////////
struct _NAVUIState {
    integer CurrentPage
    integer CurrentPopupPage
}


define_function NAVShowButtonArray(dev device[], integer address, integer state) {
    NAVCommandArray(device, "'^SHO-', itoa(address), ',', itoa(state)")
}


define_function NAVShowButton(dev device, integer address, integer state) {
    NAVCommand(device, "'^SHO-', itoa(address), ',', itoa(state)")
}


define_function NAVEnableButtonArray(dev device[], integer address, integer state) {
    NAVCommandArray(device, "'^ENA-', itoa(address), ',', itoa(state)")
}


define_function NAVEnableButton(dev device, integer address, integer state) {
    NAVCommand(device, "'^ENA-', itoa(address), ',', itoa(state)")
}


define_function NAVPageArray(dev device[], char page[]) {
    NAVCommandArray(device, "'PAGE-', page")
}


define_function NAVPage(dev device, char page[]) {
    NAVCommand(device, "'PAGE-', page")
}


define_function NAVPopupShowArray(dev device[], char popup[], char page[]) {
    if (!length_array(popup)) {
        return
    }

    if(length_array(page)) {
        NAVCommandArray(device, "'@PPN-', popup, ';', page")
        return
    }

    NAVCommandArray(device, "'@PPN-', popup")
}


define_function NAVPopupShow(dev device, char popup[], char page[]) {
    if (!length_array(popup)) {
        return
    }

    if(length_array(page)) {
        NAVCommand(device, "'@PPN-', popup,';', page")
        return
    }

    NAVCommand(device, "'@PPN-', popup")
}


define_function NAVPopupHideArray(dev device[], char popup[], char page[]) {
    if (!length_array(popup)) {
        return
    }

    if(length_array(page)) {
        NAVCommandArray(device, "'@PPF-', popup, ';', page")
        return
    }

    NAVCommandArray(device, "'@PPF-', popup")
}


define_function NAVPopupHide(dev device, char popup[], char page[]) {
    if (!length_array(popup)) {
        return
    }

    if(length_array(page)) {
        NAVCommand(device, "'@PPF-', popup, ';', page")
        return
    }

    NAVCommand(device, "'@PPF-', popup")
}


define_function NAVPopupKillArray(dev device[], char popup[]) {
    NAVCommandArray(device, "'@PPK-', popup")
}


define_function NAVPopupKill(dev device, char popup[]) {
    NAVCommand(device, "'@PPK-', popup")
}


define_function NAVPopupsClearArray(dev device[]) {
    NAVCommandArray(device, "'@PPX'")
}


define_function NAVPopupsClear(dev device) {
    NAVCommand(device, "'@PPX'")
}


define_function NAVTextArray(dev device[], integer address, char states[], char text[]) {
    NAVCommandArray(device, "'^TXT-', itoa(address), ',', states, ',', text")
}


define_function NAVText(dev device, integer address, char states[], char text[]) {
    NAVCommand(device, "'^TXT-', itoa(address), ',', states, ',', text")
}


define_function NAVDoubleBeepArray(dev device[]) {
    NAVCommandArray(device, "'ADBEEP'")
}


define_function NAVDoubleBeep(dev device) {
    NAVCommand(device, "'ADBEEP'")
}


define_function NAVBeepArray(dev device[]) {
    NAVCommandArray(device, "'ABEEP'")
}


define_function NAVBeep(dev device) {
    NAVCommand(device, "'ABEEP'")
}


define_function NAVPanelUpdate(dev device) {
    NAVCommand(device, "'@UPD'")
}


#END_IF /* __NAV_FOUNDATION_UIUTILS__ */