GAP (Francy) - Chapter 7: Francy Menus

Goto Chapter: Top 1 2 3 4 5 6 7 8 9 Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

7 Francy Menus
7.1 Categories
7.1-1 IsMenu
7.2 Families
7.3 Representations
7.3-1 IsMenuRep
7.4 Operations
7.4-1 Menu
7.4-2 Add
7.4-3 Remove
7.5 Attributes
7.5-1 Title
7.5-2 Title
7.5-3 SetTitle

### 7 Francy Menus

Menus are agregators of actions that are represented here by `Callbacks`. Menus can have SubMenus, and are constituted by a Title and a Callback.

Please see Francy-JS for client implementation.

#### 7.1 Categories

In this section we show the Francy Menu Categories.

##### 7.1-1 IsMenu

`‣ IsMenu`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `Menu` objects.

#### 7.2 Families

In this section we show the Francy Menu Families.

#### 7.3 Representations

In this section we show the Francy Menu Representations.

##### 7.3-1 IsMenuRep

`‣ IsMenuRep`( arg ) | ( filter )

Returns: `true` or `false`

Checks whether an `Object` has a `Menu` internal representation.

#### 7.4 Operations

In this section we show the Francy Menu Operations.

##### 7.4-1 Menu

`‣ Menu`( IsString(title)[, IsCallback] ) | ( operation )

Returns: `Menu`

Creates a Menu for a `Callback` Is up to the client implementation to sort out the Menu and invoke the `Callback`

##### 7.4-2 Add

`‣ Add`( IsMenu[, IsMenu, List(IsMenu)] ) | ( operation )

Returns: `Menu`

Add `Menu` to a specific `Menu` creating a Submenu. Is up to the client implementation to handle this.

##### 7.4-3 Remove

`‣ Remove`( IsMenu[, IsMenu, List(IsMenu)] ) | ( operation )

Returns: `Menu`

Remove `Menu` from a specific `Menu`. The client should be able to handle this.

#### 7.5 Attributes

In this section we show the Francy Core Attributes

##### 7.5-1 Title

`‣ Title`( arg ) | ( attribute )

Returns: `IsString` with the title of the object

A title on a `Menu` is used to identify the menu entry.

##### 7.5-2 Title

`‣ Title`( arg1 ) | ( function )

##### 7.5-3 SetTitle

`‣ SetTitle`( IsMenu, IsString ) | ( function )

Sets the title of the `Menu`.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 6 7 8 9 Ind

generated by GAPDoc2HTML