/*
 * Pane
 *   Handles all those many problems you get with panes
 *
 * v. 1.100 (25 July 1991)
 *
 * © 1991-1998 Straylight
 */

/*----- Licensing note ----------------------------------------------------*
 *
 * This file is part of Straylight's Steel library.
 *
 * Steel 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; either version 2, or (at your option)
 * any later version.
 *
 * Steel 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 Steel.  If not, write to the Free Software Foundation,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __pane_h
#define __pane_h

#ifndef __wimp_h
#include "wimp.h"
#endif

typedef struct pane__panestr *pane;

#ifndef __listbox_h
#include "listbox.h"
#endif

/*
 * pane pane_create(wimp_w tool)
 *
 * Use
 *  Sets up a structure for a pane, and returns a handle.
 *
 * Parameters
 *  wimp_w tool == the window handle of the tool window (the one that isn't
 *  a pane)
 *
 * Returns
 *  An abstract handle to the pane.
 */

pane pane_create(wimp_w tool);

/*
 * void pane_addPane(pane p,wimp_w w)
 *
 * Use
 *  Registers a new pane as being associated with the tool window given in 
 *  pane_create().
 *
 * Parameters
 *  pane p == the pane handle for the tool window
 *  wimp_w w == the window handle of the new pane
 */

void pane_addPane(pane p,wimp_w w);

/*
 * void pane_addListbox(pane p,list l)
 *
 * Use
 *  Adds a listbox to the tool window.  Handles things properly, so that
 *  scroll bars and things appear at the right time.
 *
 * Parameters
 *  pane p == the pane to add to
 *  list l == the list to add
 */

void pane_addListbox(pane p,list l);

/*
 * void pane_delete(pane p)
 *
 * Use
 *  Destroys and free()s the memory occupied by a pane structure.
 *
 * Parameters
 *  pane p == the pane's handle
 */

void pane_delete(pane p);

/*
 * void pane_removePane(pane p,wimp_w w)
 *
 * Use
 *  Removes the specified pane from the structure.
 *
 * Parameters
 *  pane p == the pane in question
 *  wimp_w w == the window to remove
 */

void pane_removePane(pane p,wimp_w w);

/*
 * void pane_updatePanes(pane p)
 *
 * Use
 *  Updates position of panes attached to the main window after it has been 
 *  moved.
 *
 * Parameters
 *  pane p == the pane handle
 */

void pane_updatePanes(pane p);

/*
 * void pane_moved(pane p)
 *
 * Use
 *  Asks the pane segment to reopen a pane in response to an wimp_EOPEN
 *  event.
 *
 * Parameters
 *  pane p == the pane handle
 */

void pane_moved(pane p);

/*
 * void pane_front(pane p)
 *
 * Use
 *  Moves a tool window and associated panes to the front of the screen.
 *
 * Parameters
 *  pane p == the pane handle
 */

void pane_front(pane p);

/*
 * void pane_close(pane p)
 *
 * Use
 *  This routine will close all the windows attached to the pane structure.
 *
 * Parameters
 *  pane p == the pane handle
 */

void pane_close(pane p);

#endif