help.c

Go to the documentation of this file.

/*
 * Copyright 2013-4 Chris Young <chris@unsatisfactorysoftware.co.uk>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * NetSurf is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "amiga/os3support.h"
 
#include "amiga/help.h"
 
/* AmigaGuide class */
#include "amiga/agclass/amigaguide_class.h"
 
static Class *AmigaGuideClass = NULL;
static Object *AmigaGuideObject = NULL;
 
/* This array needs to match the enum in help.h */
CONST_STRPTR context_nodes[] = {
        "Main",
        "GUI",
        "Prefs",
        NULL
};
 
static void ami_help_init(struct Screen *screen)
{
        AmigaGuideClass = initAGClass();
 
        AmigaGuideObject = NewObject(AmigaGuideClass, NULL,
                AMIGAGUIDE_Name, "PROGDIR:NetSurf.guide",
                AMIGAGUIDE_BaseName, "NetSurf",
                AMIGAGUIDE_Screen, screen,
                AMIGAGUIDE_ContextArray, context_nodes,
                AMIGAGUIDE_ContextID, AMI_HELP_MAIN,
                TAG_DONE);
}
 
void ami_help_open(ULONG node, struct Screen *screen)
{
        if(AmigaGuideObject == NULL) ami_help_init(screen);
        SetAttrs(AmigaGuideObject, AMIGAGUIDE_ContextID, node, TAG_DONE);
        IDoMethod(AmigaGuideObject, AGM_OPEN, NULL);
}
 
void ami_help_free(void)
{
        if (AmigaGuideObject) DisposeObject(AmigaGuideObject);
        if (AmigaGuideClass) freeAGClass(AmigaGuideClass);
        
        AmigaGuideObject = NULL;
        AmigaGuideClass = NULL;
}
 
void ami_help_new_screen(struct Screen *screen)
{
        if(AmigaGuideObject == NULL) return;
        SetAttrs(AmigaGuideObject, AMIGAGUIDE_Screen, screen, TAG_DONE);
}
 
ULONG ami_help_signal(void)
{
        ULONG ag_sig = 0;
        if(AmigaGuideObject)
                GetAttr(AMIGAGUIDE_Signal, AmigaGuideObject, &ag_sig);
        return ag_sig;
}
 
void ami_help_process(void)
{
        ULONG ret = IDoMethod(AmigaGuideObject, AGM_PROCESS, NULL);
        if(ret) ami_help_free();
}