FrancyMessage is an object that holds a message.
These messages can be used to provide information to users in the form of SUCCESS, INFO, WARNING, ERROR. It is up to the client implementation to handle these messages and their types in a fashionable manner. Please see Francy-JS for client implementation.
In this section we show all Francy FrancyMessage Categories.
‣ IsFrancyMessage( arg ) | ( filter ) |
Returns: true or false
Identifies FrancyMessage objects.
‣ IsFrancyMessageType( arg ) | ( filter ) |
Returns: true or false
Identifies MessageType objects.
In this section we show all Francy FrancyMessage Families.
In this section we show all Francy FrancyMessage Representations.
‣ IsFrancyMessageRep( arg ) | ( filter ) |
Returns: true or false
Checks whether an Object has a FrancyMessage internal representation.
‣ IsFrancyMessageTypeRep( arg ) | ( filter ) |
Returns: true or false
Checks whether an Object has a FrancyMessage internal representation.
In this section we show all Francy FrancyMessage Operations.
‣ FrancyMessage( IsString, IsString ) | ( operation ) |
Returns: FrancyMessage
Adds an info label with the format "label: value"
Examples:
Create FrancyMessage of all types within a canvas:
gap> canvas := Canvas("Example Canvas / Shape with Messages"); gap> graph := Graph(GraphType.HASSE); # will go throughout graphs later gap> shape := Shape(ShapeType.CIRCLE); # will go throughout shapes later gap> Add(graph, shape); gap> Add(canvas, graph); gap> Add(canvas, FrancyMessage(FrancyMessageType.INFO, "Hello")); gap> Add(shape, FrancyMessage(FrancyMessageType.INFO, "Hello")); gap> Add(canvas, FrancyMessage(FrancyMessageType.ERROR, "Oops", "Hello")); gap> Add(shape, FrancyMessage(FrancyMessageType.ERROR, "Oops", "Hello")); gap> Add(canvas, FrancyMessage(FrancyMessageType.WARNING, "Hello")); gap> Add(shape, FrancyMessage(FrancyMessageType.WARNING, "Hello")); gap> Add(canvas, FrancyMessage(FrancyMessageType.SUCCESS, "Hello")); gap> Add(shape, FrancyMessage(FrancyMessageType.SUCCESS, "Hello")); gap> Add(canvas, FrancyMessage("Hello", "World")); gap> Add(shape, FrancyMessage("Hello", "World"));
In this section we show all Global FrancyMessage Records for multi purpose.
In this section we show all FrancyMessage Core Attributes
‣ Title( arg ) | ( attribute ) |
Returns: IsString with the title of the object
A title on a FrancyMessage is used to display the title information to the user.
‣ Title( arg1 ) | ( operation ) |
‣ SetTitle( IsFrancyMessage, IsString ) | ( operation ) |
Sets the title of the FrancyMessage.
‣ Value( arg ) | ( attribute ) |
Returns: IsString with the title of the object
A value on a FrancyMessage is used to display the information to the user.
‣ Value( arg1 ) | ( operation ) |
‣ SetValue( IsFrancyMessage, IsString ) | ( operation ) |
Sets the actual message of the FrancyMessage.
‣ Add( IsFrancyMessage[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: FrancyMessage
Add a Callback to a specific FrancyMessage.
‣ Remove( IsFrancyMessage[, IsCallback, List(IsCallback)] ) | ( operation ) |
Returns: FrancyMessage
Remove a Callback from a specific FrancyMessage.
generated by GAPDoc2HTML