API:PageWindowRemoveSplitableWindow

UI Lua API · PageWindow functions
Version: WAR 1.4.8

Removes a window from a PageWindow's list of splitable windows.

PageWindowRemoveSplitableWindow(pageWindowName, windowName)

Arguments

pageWindowName

string – Name of the PageWindow.

windowName

string – Name of the window to remove from the list.

Returns

Nothing.

Details

• This undoes PageWindowAddSplitableWindow for one window. The pages are not laid out again; call PageWindowUpdatePages afterwards.
• If windowName does not exist or is not in the list, the call does nothing. No error is raised for it.
• 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 'PageWindowRemoveSplitableWindow': Window %s does not exist
• Error in function call 'PageWindowRemoveSplitableWindow': Window %s is not a PageWindow

Example

A minimal example built from the signature:

PageWindowRemoveSplitableWindow( "MyBookPageWindow", "MyBookBigImage" )
PageWindowUpdatePages( "MyBookPageWindow" )

See also

• PageWindowAddSplitableWindow
• PageWindowClearSplitableWindows