API:PageWindowRemovePageBreak

UI Lua API · PageWindow functions
Version: WAR 1.4.8

Removes a window from a PageWindow's list of page breaks.

PageWindowRemovePageBreak(pageWindowName, breakWindowName)

Arguments

pageWindowName

string – Name of the PageWindow.

breakWindowName

string – Name of the window to remove from the page-break list.

Returns

Nothing.

Details

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

Example

From default/ea_tomeofknowledge/source/tomewindow_warjournal.lua:

if( TomeWindow.WarJournal.CurEntryData.glyphActivities[1] == nil and TomeWindow.WarJournal.CurEntryData.activities[1] == nil ) then
    WindowSetShowing( "WarJournalEntryTextButton", false )
    PageWindowAddPageBreak( "WarJournalEntryInfoPageWindow", parentWindow.."VertScrollAnchor" )
    return
else
    WindowSetShowing("WarJournalEntryTextButton", true)
    PageWindowRemovePageBreak( "WarJournalEntryInfoPageWindow", parentWindow.."VertScrollAnchor" )
end

See also

• PageWindowAddPageBreak
• PageWindowClearPageBreaks
• PageWindowUpdatePages