HasNumberedPages

CaptionInfo GoRelative TypeKeys

Attributes

CanWrap CaptionPhrase CaptionTemplate PageCount PageNumber ShowNameBarInfo

Fields

Define Class HasNumberedPages;
    mixes in with Scene;
    has dispatcher hintdata;
    
    attribute CanWrap: Boolean, readOnly;
        // returns false
        // override sometimes to return true if left/right arrows should wrap between last and first page
    overrides CaptionInfo;
        // determines whether to show arrows based on number of pages and current page
        // displays phrase returned from CaptionPhrase
    attribute CaptionPhrase: Text, readOnly;
        // called by CaptionInfo to get text displayed between left/right arrows in name bar
        // returns result of calling MapText with iCaptionTextMapping and CaptionTemplate(self)
        // override occasionally to substitute dynamic information other than page number and count
        // override CaptionTemplate instead to change just the static parts of the caption
    attribute CaptionTemplate: Text, readOnly;
        // called by CaptionPhrase to get text template to be mapped with iCaptionTextMapping
        // returns ephemeral copy of iStandardCaptionTemplate, which is "/page number/ of /page count/"
        // override sometimes to change static parts of the caption, for instance to add a word to the end
        // override CaptionPhrase instead to change caption more dynamically    

    overrides GoRelative;
        // sets page number to next, previous, first, or last card in stack, depending on flags

    attribute PageCount: Unsigned, readOnly, noGetter;
        // must override to return maximum page number;
    attribute PageNumber: Unsigned, noGetter, noSetter;
        // must override getter to return current page number as displayed in name bar;
        // must override setter to switch displayed page;

    attribute ShowNameBarInfo: Boolean;

    overrides TypeKeys;
        // arrows do next card and previous card; sends characters to card directly (needed?)
end class;