<<>> <> <> <> <> <> <> <> <> <<>> DIRECTORY Tioga USING [Node, Location, Place], ViewerClasses USING [MouseButton, ViewerRec, Viewer], Rope USING [ROPE]; TiogaButtons: CEDAR DEFINITIONS ~ BEGIN ROPE: TYPE ~ Rope.ROPE; <<>> <> TiogaButton: TYPE = REF TiogaButtonRec; TiogaButtonRec: TYPE = RECORD [ startLoc: Tioga.Location, endLoc: Tioga.Location, proc: TiogaButtonProc, clientData: REF ANY, fork: BOOLEAN ]; <> TiogaButtonList: TYPE = LIST OF TiogaButton; TiogaButtonProc: TYPE = PROC [button: TiogaButton, clientData: REF ANY ¬ NIL, mouseButton: ViewerClasses.MouseButton ¬ red, shift, control: BOOL ¬ FALSE]; <>> <> CreateViewer: PROC [info: ViewerClasses.ViewerRec] RETURNS [v: ViewerClasses.Viewer]; <<... creates a $TiogaButtons class viewer.>> <> <<>> LoadViewer: PROC [viewer: ViewerClasses.Viewer, fileName: ROPE]; <<... loads an existing document into a TiogaButtons viewer>> <<>> CreateButton: PROC [viewer: ViewerClasses.Viewer, rope: ROPE ¬ NIL, format: ROPE ¬ NIL, looks: ROPE ¬ NIL, proc: TiogaButtonProc ¬ NIL, clientData: REF ANY ¬ NIL, fork: BOOLEAN ¬ TRUE] RETURNS [button: TiogaButton]; <<... creates a button as the last child of the document in viewer.>> <<(Client must provide nesting through TiogaOps)>> <> WrongViewerClass: ERROR; CreateButtonFromNode: PROC [node: Tioga.Node, start: INT ¬ 0, end: INT ¬ INT.LAST, proc: TiogaButtonProc ¬ NIL, clientData: REF ANY ¬ NIL, fork: BOOLEAN ¬ TRUE] RETURNS [button: TiogaButton]; <<... creates a button from the node and the offsets provided. If the start and end offsets are defaulted then the button refers to the node itself.>> <> <<>> CreateButtonForEachNode: PROC [viewer: ViewerClasses.Viewer, firstLevelOnly: BOOL ¬ FALSE, subtreeAsButton: BOOL ¬ TRUE, proc: TiogaButtonProc ¬ NIL, clientData: REF ANY ¬ NIL, fork: BOOLEAN ¬ TRUE]; <<... creates a TiogaButton for each node found in the TiogaButtons viewer>> <<>> CreateButtonAtNode: PROC[ viewer: ViewerClasses.Viewer, oldButton: TiogaButton ¬ NIL, where: Tioga.Place ¬ before, rope: ROPE ¬ NIL, format: ROPE ¬ NIL, looks: ROPE ¬ NIL, proc: TiogaButtonProc ¬ NIL, clientData: REF ANY ¬ NIL, fork: BOOLEAN ¬ TRUE ] RETURNS [button: TiogaButton]; AppendToButton: PROC [button: TiogaButton, rope: ROPE ¬ NIL, looks: ROPE ¬ NIL, proc: TiogaButtonProc ¬ NIL, clientData: REF ANY ¬ NIL, fork: BOOLEAN ¬ TRUE] RETURNS [TiogaButton]; <<... appends the formatted rope to an existing button and creates a new button for the appended text.>> <> <> <<>> DeleteButton: PROC [button: TiogaButton]; <<... deletes the button.>> <> <> <> <<>> FindTiogaButton: PROC [this: ViewerClasses.Viewer, loc: Tioga.Location] RETURNS [button: TiogaButton]; <<... returns the button at that location in the viewer, or NIL>> <<>> GetRope: PROC [button: TiogaButton] RETURNS [rope: ROPE]; <<... provides the text of the button. Can be used in place of clientData for many purposes.>> <<>> SetStyleFromRope: PROC [v: ViewerClasses.Viewer, styleRope: ROPE]; <<... sets a local style for the viewer via the StyleDef property>> <<>> ChangeButtonLooks: PUBLIC PROC [button: TiogaButton, addLooks, removeLooks: ROPE ¬ NIL]; <<... change the looks for the button starting at the start offset>> <<>> MarkViewerNotEdited: PROC [root: Tioga.Node]; <<... marks all the viewers displaying this document as not edited>> <<>> EnumerateTiogaButtons: PROC [ v: ViewerClasses.Viewer, <> Test: PROC [TiogaButton] RETURNS [BOOL], <> start: Tioga.Location ¬ [NIL, 0], <> end: Tioga.Location ¬ [NIL, INT.LAST] <> ] RETURNS [BOOL]; <> <<>> IsTiogaButtons: PROC [ViewerClasses.Viewer] RETURNS [BOOL]; IsEntireNode: PROC [TiogaButton] RETURNS [BOOL]; State: TYPE = { buttoning, editing }; StateButton: PROC [v: ViewerClasses.Viewer, show: BOOL ¬ TRUE]; <<... called to show (TRUE) or hide (FALSE) the button on the viewer which allows the user to toggle between editing the underlying document and buttoning. Initially, the button is hidden for upward compatibility. Does nothing if the viewer is not a top level viewer (can't have it's own buttons).>> <<>> SetState: PROC [v: ViewerClasses.Viewer, val: State]; <<... called to set the state of the viewer directly.>> <<>> GetState: PROC [v: ViewerClasses.Viewer] RETURNS [State]; <<... called to get the state of the viewer.>> <<>> WasModifiedProc: TYPE = PROC [v: ViewerClasses.Viewer]; <<... called by TiogaButtons to allow the client to redo the buttons upon reentering the buttoning state or after some non-user document edit, like with an active docuement, while in "button mode". All previously created buttons are removed before this call is made.>> RegisterModifiedProc: PROC [v: ViewerClasses.Viewer, proc: WasModifiedProc]; <<... called to register a procedure to be called in the event of a change to the document. To "unregister" the procedure, register NIL as the proc.>> IsViewerEdited: PROC [root: Tioga.Node] RETURNS [edited: BOOL]; <<... returns whether the edited bit of the document (viewer) is set.>> END.