API:PageWindowAddSplitableWindow

UI Lua API · PageWindow functions
Version: WAR 1.4.8

Adds a window to a PageWindow's list of splitable windows.

PageWindowAddSplitableWindow(pageWindowName, windowName)

Arguments

pageWindowName

string – Name of the PageWindow.

windowName

string – Name of a window inside the PageWindow's content.

Returns

Nothing.

Details

• The window is added to the PageWindow's splitable-window list. Nothing is laid out by this call; the list is used by PageWindowUpdatePages.
• During layout, a window that starts on a page but runs past its bottom is normally moved to the next page. A window in this list is not moved. Instead the client creates a second window named windowName_pgbrk from the same definition and with the same size, and lays it out as well.
• If windowName does not exist, the call does nothing. No error is raised for it.
• A window that is already in the list is not added a second time.
• The stock UI never calls this function.
• The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

Errors

• Error in function call 'PageWindowAddSplitableWindow': Window %s does not exist
• Error in function call 'PageWindowAddSplitableWindow': Window %s is not a PageWindow

Example

A minimal example built from the signature:

PageWindowAddSplitableWindow( "MyBookPageWindow", "MyBookBigImage" )
PageWindowUpdatePages( "MyBookPageWindow" )

See also

• PageWindowRemoveSplitableWindow
• PageWindowClearSplitableWindows
• PageWindowUpdatePages