diff options
author | Chris Young <chris@unsatisfactorysoftware.co.uk> | 2017-01-01 13:28:11 +0000 |
---|---|---|
committer | Chris Young <chris@unsatisfactorysoftware.co.uk> | 2017-01-01 13:28:11 +0000 |
commit | 8196f5b60241a6389ca3b76446de131a3dd2e891 (patch) | |
tree | cdf7bc38ca5e133f3d00de9ad78ca8aa1c9ad2e9 /frontends/amiga/corewindow.h | |
parent | bb2341898113f37936832c8828bd515c3e3860c9 (diff) | |
download | netsurf-8196f5b60241a6389ca3b76446de131a3dd2e891.tar.gz netsurf-8196f5b60241a6389ca3b76446de131a3dd2e891.tar.bz2 |
Basic template for an Amiga core window
Drawing and event processing not written yet
Diffstat (limited to 'frontends/amiga/corewindow.h')
-rw-r--r-- | frontends/amiga/corewindow.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/frontends/amiga/corewindow.h b/frontends/amiga/corewindow.h new file mode 100644 index 000000000..d6f842aff --- /dev/null +++ b/frontends/amiga/corewindow.h @@ -0,0 +1,123 @@ +/* + * Copyright 2017 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/>. + */ + +#ifndef AMIGA_COREWINDOW_H +#define AMIGA_COREWINDOW_H + +#include "netsurf/core_window.h" + +#include "amiga/gui.h" /* need to know the size of ami_generic_window :( */ +#include "amiga/plotters.h" + +/** + * BOOPSI objects + */ + +enum { + GID_CW_WIN = 0, /* window object */ + GID_CW_MAIN, /* root layout object */ + GID_CW_DRAW, /* drawing area (space.gadget) */ + GID_CW_HSCROLL, /* horizontal scroller */ + GID_CW_VSCROLL, /* vertical scroller */ + GID_CW_LAST +}; + +/** + * Amiga core window state + */ +struct ami_corewindow { + /* + * Any variables common to any frontend window would go here. + * e.g. drawing area handles, toolkit pointers or other state + */ + struct ami_generic_window w; + struct Window *win; + Object *objects[GID_CW_LAST]; + + struct Hook idcmp_hook; + + /** stuff for our off-screen render bitmap */ + struct gui_globals gg; + struct MinList *shared_pens; + + /** drag status set by core */ + core_window_drag_status drag_status; + + /** table of callbacks for core window operations */ + struct core_window_callback_table *cb_table; + + /** + * callback to draw on drawable area of Amiga core window + * + * \param ami_cw The Amiga core window structure. + * \param r The rectangle of the window that needs updating. + * \return NSERROR_OK on success otherwise apropriate error code + */ + nserror (*draw)(struct ami_corewindow *ami_cw, struct rect *r); + + /** + * callback for keypress on Amiga core window + * + * \param ami_cw The Amiga core window structure. + * \param nskey The netsurf key code. + * \return NSERROR_OK if key processed, + * NSERROR_NOT_IMPLEMENTED if key not processed + * otherwise apropriate error code + */ + nserror (*key)(struct ami_corewindow *ami_cw, uint32_t nskey); + + /** + * callback for mouse event on Amiga core window + * + * \param ami_cw The Amiga core window structure. + * \param mouse_state mouse state + * \param x location of event + * \param y location of event + * \return NSERROR_OK on sucess otherwise apropriate error code. + */ + nserror (*mouse)(struct ami_corewindow *ami_cw, browser_mouse_state mouse_state, int x, int y); + + /** + * callback to close an Amiga core window + * + * \param ami_cw The Amiga core window structure. + */ + nserror (*close)(struct ami_corewindow *ami_cw); + +}; + +/** + * initialise elements of Amiga core window. + * + * As a pre-requisite the draw, key and mouse callbacks must be defined + * + * \param example_cw An Amiga core window structure to initialise + * \return NSERROR_OK on successful initialisation otherwise error code. + */ +nserror ami_corewindow_init(struct ami_corewindow *ami_cw); + +/** + * finalise elements of Amiga core window. + * + * \param ami_cw An Amiga core window structure to finialise + * \return NSERROR_OK on successful finalisation otherwise error code. + */ +nserror ami_corewindow_fini(struct ami_corewindow *ami_cw); + +#endif + |