gui.getDesktopMaximizedPane

Returns the index number of the currently maximized pane on a ShiVa desktop.

Prototype

hPane = gui.getDesktopMaximizedPane ( nDesktop )

Description

Multiple panes can live on the same ShiVa desktop. Panes can be maximized through the 2-arrow-symbol in the pane corner.

Parameters

nDesktop - index number of the desktop

Return values

hPane - pane handle that is maximized, or nil

Sample

function onMaximize ( )
 
    local nDesktop = gui.getCurrentDesktop ( )
    local nPane = gui.getDesktopPaneIndexAtPoint ( nDesktop )
    if  ( nPane ) then
        if ( gui.getDesktopMaximizedPane ( nDesktop ) == nPane ) then
            gui.maximizedDesktopPane ( nDesktop, nil )
        else
            gui.maximizedDesktopPane ( nDesktop, nPane )
        end
    end
end

Available since ShiVa 2.0