GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CURSES::WIDGETS::BUTTONSET (3)

.ds Aq ’

NAME

Curses::Widgets::ButtonSet - Button Set Widgets

CONTENTS

MODULE VERSION

$Id: ButtonSet.pm,v 1.103 2002/11/03 23:31:26 corliss Exp corliss $

SYNOPSIS



  use Curses::Widgets::ButtonSet;

  $btns = Curses::Widgets::ButtonSet->({
    LENGTH      => 10,
    VALUE       => 0,
    INPUTFUNC   => \&scankey,
    FOREGROUND  => white,
    BACKGROUND  => black,
    BORDER      => 1,
    BORDERCOL   => red,
    FOCUSSWITCH => "\t\n",
    HORIZONTAL  => 1,
    PADDING     => 1,
    X           => 1,
    Y           => 1,
    LABELS      => [qw(OK CANCEL)],
    });

  $btns->draw($mwh, 1);

  See the Curses::Widgets pod for other methods.



REQUIREMENTS

Curses
Curses::Widgets

DESCRIPTION

Curses::Widgets::ButtonSet provides simplified OO access to Curses-based button sets. Each object maintains it’s own state information.

METHODS

    new (inherited from Curses::Widgets)



  $btns = Curses::Widgets::ButtonSet->({
    LENGTH      => 10,
    VALUE       => 0,
    INPUTFUNC   => \&scankey,
    FOREGROUND  => white,
    BACKGROUND  => black,
    BORDER      => 1,
    BORDERCOL   => red,
    FOCUSSWITCH => "\t\n",
    HORIZONTAL  => 1,
    PADDING     => 1,
    X           => 1,
    Y           => 1,
    LABELS      => [qw(OK CANCEL)],
    });



The new method instantiates a new ButtonSet object. The only mandatory key/value pairs in the configuration hash are <B>XB>, <B>YB>, and <B>LABELSB>. All others have the following defaults:



  Key         Default    Description
  ============================================================
  LENGTH             10  Number of columns for each button label
  VALUE               0  Button selected (0-based indexing)
  INPUTFUNC   \&scankey  Function to use to scan for keystrokes
  FOREGROUND      undef  Default foreground colour
  BACKGROUND      undef  Default blackground colour
  BORDER              1  Display border around the set
  BORDERCOL       undef  Foreground colour for border
  FOCUSSWITCH    "\t\n"  Characters which signify end of input
  HORIZONTAL          1  Horizontal orientation for set
  PADDING             1  Number of spaces between buttons



The last option, <B>PADDINGB>, is only applicable to horizontal sets without borders.

    draw



  $btns->draw($mwh, 1);



The draw method renders the button set in its current state. This requires a valid handle to a curses window in which it will render itself. The optional second argument, if true, will cause the set’s selected button to be rendered in standout mode (inverse video).

HISTORY

1999/12/29 — Original button set widget in functional model
2001/07/05 — First incarnation in OO architecture

AUTHOR/COPYRIGHT

(c) 2001 Arthur Corliss (corliss@digitalmages.com)
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WIDGETS::BUTTONSET (3) 2002-11-14

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.