list_box.h

Go to the documentation of this file.

#ifndef LIST_BOX_CLASS
#define LIST_BOX_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : list_box                                                          *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Shows the user a set of text strings in a box, which may optionally      *
*  trigger an event function for that item.                                   *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  This program 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 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

// Model:
//
//   The origin of the list_box is the lower left corner.  List_box objects'
//   origins are measured in universal coordinates.

#include "dll_wp_active.h"

#include <basis/istring.h>

#include <wp_passive/worker.h>

enum list_box_kinds { DISPLAY_ONLY, SINGLE_SELECTION, MULTIPLE_SELECTION };
  // These are the different types of list_boxes that can be created.
  // DISPLAY_ONLY means that the items are visible but that no action occurs
  // when the user selects an item.  SINGLE_SELECTION means that the user
  // is allowed to select one item, the selection of which causes the list_
  // box's event function to be invoked.  only one item is allowed to be
  // selected at once.  MULTIPLE_SELECTION allows more than one item to be
  // selected; the event function is called for each item as it is selected

class WP_ACTIVE_CLASS_STYLE list_box : public worker, private array<istring>
{
public:
  list_box(manager &parent, const c_point &origin, int entries,
          list_box_kinds type, const color &foreground = colors::WHITE,
          const color &background = colors::BLACK);
    // creates a list_box capable of holding "entries" items.
  
  ~list_box();

  IMPLEMENT_CLASS_NAME("list_box");

  istring contents(int index) const;
    // returns a string containing the contents of the box at "index".  an
    // empty string is returned if the index is not valid.
  void contents(int index, const istring &to_show);
    // sets the contents of the list_box to "to_show".  the call is ignored if
    // index is invalid.

  const array<istring> &items() const;
    // returns a reference to the list of items.

  virtual void selection_event(int index_selected);
    // called when the user selects an item.

  virtual void draw();
    // call when the contents have been completely set up.

  static void list_box_callback(window_handle h, list_box *me,
          XmListCallbackStruct *calldata);
    // invoked when motif notices a change in the list.

private:
  istring _contents;
  list_box_kinds _kind;

  window_handle create_handle();
};

#endif

---