source --> actor

class bicotiActorGraphicMenu
    extends bicotiActorGraphic as public
    extends bicotiInteractionSourceMenu as public

Clase base de la que se derivan los menús.

Un bicotiActorGraphicMenu define las interfaces comunes de los menús soportados por bicoti: bicotiActorGraphicMenuBar y bicotiActorGraphicMenuPopup. Es fuente de eventos de menú. Un bicotiActorGraphicMenu puede contener dos tipos de elementos ítems y separadores. A su vez un ítem puede tener asociado un bicotiActorGraphicMenuPopup.

Source:
../../source/actor/actor_graphic_menu.hpp:23

See Also:
bicotiActorGraphicMenuBar, bicotiActorGraphicMenuPopup, bicotiHomologousGraphicMenu

Nested Classes, Structs and Unions:
InternalStructure [protected] Clase para uso interno de bicotiActorGraphicMenu.

Constructors Index

bicotiActorGraphicMenu
[public] Constructor.
~bicotiActorGraphicMenu
[public] Destructor


Variables Index

current_id
[protected]
elements_list
[protected]


Methods Index

AddItem
[public] Agrega un ítem al menú.
AddItem
[public] Agrega un item y le asocia un submenú.
AddSeparator
[public] Agrega un separador al menú.
CheckItem
[protected] Verifica que la opción pertenzca al menú.
CheckItem
[public] Indica si hay un ítem con este identificador en el menú.
GetElementsNumber
[public] Cantidad de elementos del menú creados.
GetItem
[public] Devuelve el nombre de la opción asociada al identificador.
GetPopupForItem
[public] Devuelve un puntero al submenú asociado al identificador.
IsItem
[public] Indica si es un ítem del menú.
IsSeparator
[public] Indica si es un separador del menú.
RemoveElement
[public] Borra un ítem o separador del menú.


Constructors

bicotiActorGraphicMenu

public bicotiActorGraphicMenu ( char * act_name ) ;

Constructor.

Parameters:
act_name nombre del actor.

bicotiActorGraphicMenu

public virtual ~ bicotiActorGraphicMenu ( ) ;

Destructor


Variables

current_id

protected static int current_id

elements_list

protected vector < InternalStructure > elements_list


Methods

CheckItem

protected bool CheckItem ( char * item ) ;

Verifica que la opción pertenzca al menú.

Parameters:
item nombre de la opción.

Return:
true si item está en el menú o false en caso contrario.

AddItem

public int AddItem ( char * item ) ;

Agrega un ítem al menú.

Parameters:
item nombre de la nueva opción del men

Return:
identificador de ítem (un entero único).

AddItem

public int AddItem ( char * item ,
                     bicotiActorGraphicMenuPopup * pupm ) ;

Agrega un item y le asocia un submenú.

El submenú se desplega automáticamente cuando se selecciona ese ítem

Parameters:
item nombre de la nueva opción del menú.
pupm submenú.

Return:
identificador del ítem (un entero único).

AddSeparator

public int AddSeparator ( ) ;

Agrega un separador al menú.

Un separdador es una división entre las opciones de un menú, si se clickea sobre la misma no ocurre nada.

Return:
identificador del separador (un entero único).

CheckItem

public bool CheckItem ( int item_id ) ;

Indica si hay un ítem con este identificador en el menú.

Parameters:
item_id identificador del ítem o separador a eliminar.

Return:
true si item_id es identificador de un ítem del menú.

RemoveElement

public void RemoveElement ( int item_id ) ;

Borra un ítem o separador del menú.

RemoveItem borra un item o separador dado un identificador. Los identifacadores no se vuelven a usar si se borra el elemento correspondiente. Si no hay un elemento asociado al identificador se produce una excepción.

Exception:
bicotiException si item_id no es un item del menú.

Parameters:
item_id identificador de item a borrar.

IsItem

public bool IsItem ( int item_id ) ;

Indica si es un ítem del menú.

Dado un identificador indica si el mismo corresponde a un ítem. Si no hay un elemento asociado al identificador se produce una excepción.

Exception:
bicotiException si item_id no es un item del menú.

Parameters:
item_id identificador de ítem.

Return:
true si item_id corresponde a un ítem del menú.

IsSeparator

public bool IsSeparator ( int item_id ) ;

Indica si es un separador del menú.

Dado un identificador indica si el mismo corresponde a un separador. Si no hay un elemento asociado al identificador se produce una excepción.

Exception:
bicotiException si item_id no es un item del menú.

Parameters:
item_id identificador de ítem.

Return:
true si item_id corresponde a un separador del menú.

GetItem

public char * GetItem ( int item_id ) ;

Devuelve el nombre de la opción asociada al identificador.

Devuelve el nombre de la opción asociada al identificador. Si el elemento no existe o es un separador se produce una excepción.

Exception:
bicotiException si item_id no es un item del menú o es separador.

Parameters:
item_id identificador de ítem.

Return:
el nombre de la opción asociada a item_id.

GetPopupForItem

public bicotiActorGraphicMenuPopup * GetPopupForItem ( int item_id ) ;

Devuelve un puntero al submenú asociado al identificador.

Devuelve un puntero al submenú asociado al identificador. Si no hay submenúse devuelve NULL. Si el elemento no existe o es un separador se produce una excepción.

Exception:
bicotiException si item_id no es un item del menú o es separador.

Parameters:
item_id identificador de ítem.

Return:
el submenú asociado a item_id.

GetElementsNumber

public int GetElementsNumber ( ) ;

Cantidad de elementos del menú creados.

GetElementsNumber devuelve el valor del identificador asignado al último elemento creado. Ese valor siempre es creciente.

Return:
cantidad de elementos del menú creados.

bicoti II

bicoti II
Claudio Risso
Wilman Alarcon

Click here to return to the top of the page.