Referência ao ficheiro src/vapiMacroList.h

Functions and handlers for the list of Macros. Mais...

#include "vapiOperationList.h"
#include "vapiMacro.h"
#include "vapiLists.h"

Diagrama de dependências de inclusão para vapiMacroList.h:

Este grafo mostra quais são os ficheiros que incluem directamente ou indirectamente este ficheiro:

Ir para o código fonte deste ficheiro.

Definições de tipos
typedef vList	vMacroList
	this is defined only to make the code easier to interpret.
Funções
void	vapiLoadExampleMacros (vMacroList *MacroList, vOperationList *OperationList)
	Loads the defined example macros. This is only used in the main function at start.
void	vapiMacroListAddItem (vMacroList *MacroList, vMacroHeader *MacroHeader)
	add one Macro to the List.
int	vapiMacroListCountElements (vMacroList *MacroList)
	count list elements
void	vapiMacroListDeleteItem (vMacroList *MacroList, int Delete)
	Delete one Macro from the List.
int	vapiMacroListMacroExist (vMacroList *MacroList, char *string, int WhatToReturn)
	Checks if a Macro exists in the list and/or returns its index.
vMacroList *	vapiMacroListNew ()
	Start a new List of Macros.
vMacroHeader *	vapiMacroListSelectItem (vMacroList *MacroList, int Item)
	Select a macro from the list, from the requested position.

---

Descrição detalhada

Functions and handlers for the list of Macros.

Aviso:

Some functions here described are just bogus functions related to old code. Please use v_list* functions to manipulate vMacroList in newly written code.

Definido no ficheiro vapiMacroList.h.

---

Documentação dos tipos

vMacroList

this is defined only to make the code easier to interpret.

Definido na linha 15 do ficheiro vapiMacroList.h.

---

Documentação das funções

void vapiLoadExampleMacros	(	vMacroList *	MacroList,
		vOperationList *	OperationList
	)

Loads the defined example macros. This is only used in the main function at start.

Definido na linha 69 do ficheiro vapiMacroList.c.

Referências MacroList, OperationList e vapiMacroXMLLoadToList().

Referenciado por main().

{
        int numberOfExampleMacros = 8, i;
        char *ExampleMacros[8];

        ExampleMacros[0] = "Macros_exemplo/fusivel_azul.xml";
        ExampleMacros[1] = "Macros_exemplo/fusivelermelho.xml";
        ExampleMacros[2] = "Macros_exemplo/fusivel_rosa.xml";
        ExampleMacros[3] = "Macros_exemplo/DetectarFusiveis.xml";
        ExampleMacros[4] = "Macros_exemplo/comprimidos.xml";
        ExampleMacros[5] = "Macros_exemplo/OCRermelho.xml";
        ExampleMacros[6] = "Macros_exemplo/pattern_match.xml";
        ExampleMacros[7] = "Macros_exemplo/pattern_search.xml";


        for (i = 0; i < numberOfExampleMacros; i++)
        {

                vapiMacroXMLLoadToList (MacroList, OperationList,
                                        ExampleMacros[i]);
        }


}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiMacroListAddItem	(	vMacroList *	MacroList,
		vMacroHeader *	MacroHeader
	)

add one Macro to the List.

Definido na linha 18 do ficheiro vapiMacroList.c.

Referências MacroList e v_list_append().

Referenciado por vapiGtkMacroCreate() e vapiMacroXMLLoadToList().

{
        v_list_append ((vList *) MacroList, MacroHeader);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

int vapiMacroListCountElements

(

vMacroList *

MacroList

)

count list elements

Definido na linha 25 do ficheiro vapiMacroList.c.

Referências MacroList e v_list_count_elements().

Referenciado por vapiGtkCbMacroStart(), vapiGtkMacroOpenFromXML(), vapiMacroListMacroExist() e vapiMacroListToText().

{
        return v_list_count_elements ((vList *) MacroList);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiMacroListDeleteItem	(	vMacroList *	MacroList,
		int	Delete
	)

Delete one Macro from the List.

Parâmetros:

Delete

the number of the macro to delete.

Definido na linha 31 do ficheiro vapiMacroList.c.

Referências MacroList, v_list_delete_item() e vapiMacroDelete().

Referenciado por vapiGtkMacroDeleteMacro().

{
        v_list_delete_item ((vList *) MacroList,
                            (vFreeFunction *) & vapiMacroDelete, Delete);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

int vapiMacroListMacroExist	(	vMacroList *	MacroList,
		char *	string,
		int	WhatToReturn
	)

Checks if a Macro exists in the list and/or returns its index.

Retorna:

Se a Macro existir retorna -1 ou o indice da Macro. -3 se não existir, e -2 se não existir e tiver sido requerido o indice.

Definido na linha 100 do ficheiro vapiMacroList.c.

Referências MacroList, _vMacroHeader::MacroName, vapiMacroListCountElements() e vapiMacroListSelectItem().

Referenciado por vapiCheckOperations(), vapiGtkMacroCreate(), vapiGtkMacrosTableSetSelectedMacro(), vapiGtkMacroTableModel(), vapiGtkMacroTablesApplyUntil() e vapiMacroXMLLoadToList().

{

        int i, ListSize;
        vMacroHeader *MacroHeader;
        /*
         * Verificar se já existe a Macro.
         */

        ListSize = vapiMacroListCountElements ((vMacroList *) MacroList);
        for (i = 0; i < ListSize; i++)
        {
                MacroHeader =
                        vapiMacroListSelectItem ((vMacroList *) MacroList, i);
                if (!strcmp (MacroHeader->MacroName, string))
                {
                        if (WhatToReturn)
                        {
                                return -1;
                        }
                        else
                        {
                                return i;
                        }
                }
        }
        if (!WhatToReturn)
        {
                return -3;
        }

        return -2;
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

vMacroList* vapiMacroListNew

(

)

Start a new List of Macros.

Definido na linha 12 do ficheiro vapiMacroList.c.

Referências v_list_new().

Referenciado por main().

{
        return (vMacroList *) v_list_new ();
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

vMacroHeader* vapiMacroListSelectItem	(	vMacroList *	MacroList,
		int	Item
	)

Select a macro from the list, from the requested position.

Parâmetros:

Item

the position of the macro

Retorna:

a pointer to the MacroHeader. This pointer cannot be freed.

Definido na linha 38 do ficheiro vapiMacroList.c.

Referências MacroList e v_list_get().

Referenciado por vapiCheckOperations(), vapiGtkCbMacroStart(), vapiGtkMacroAppendItem(), vapiGtkMacroApply(), vapiGtkMacroChange(), vapiGtkMacroDeleteItem(), vapiGtkMacroInsertItem(), vapiGtkMacroItemMoveDown(), vapiGtkMacroItemMoveToBottom(), vapiGtkMacroItemMoveToTop(), vapiGtkMacroItemMoveUp(), vapiGtkMacroLauchDeleteDialog(), vapiGtkMacroLaunchChangeWindow(), vapiGtkMacroOpenFromXML(), vapiGtkMacroSaveToXML(), vapiGtkMacroSelect(), vapiGtkMacroSelectItem(), vapiGtkMacroSelectNext(), vapiGtkMacroTable(), vapiGtkMacroTableAux(), vapiGtkMacroTablesApplyUntil(), vapiGtkMacroUpdateItemOptions(), vapiMacroListMacroExist() e vapiMacroListToText().

{
        return ((vMacroHeader *) v_list_get ((vList *) MacroList, Item));
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

---