# -*- perl -*-

#
# Menu.pm
#
# Copyright (C) 2008, 2009 Francesco Salvestrini
#
# 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 program 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

package Choicetool::Widgets::Menu;

use 5.8.0;

use warnings;
use strict;
use diagnostics;

use Choicetool::Base::Debug;
use Choicetool::Base::Trace;
use Choicetool::Widgets::Widget;

use vars qw(@ISA);
@ISA = qw(Choicetool::Widgets::Widget);

sub new ($$)
{
    my $class = shift;
    my $id    = shift;

    assert(defined($class));

    my $self = $class->SUPER::new($id);

    return bless($self, $class);
}

sub type {
    my $self  = shift;
    my $value = shift;

    assert(defined($self));

    if (defined($value)) {
        $self->{TYPE} = $value;
    }

    return $self->{TYPE};
}

sub label {
    my $self  = shift;
    my $value = shift;

    assert(defined($self));

    if (defined($value)) {
        $self->{LABEL} = $value;
    }

    return $self->{LABEL};
}

sub default {
    my $self  = shift;
    my $value = shift;

    assert(defined($self));

    if (defined($value)) {
        $self->{DEFAULT} = $value;
    }

    return $self->{DEFAULT};
}

sub range {
    my $self  = shift;
    my $value = shift;

    assert(defined($self));

    if (defined($value)) {
        $self->{RANGE} = $value;
    }

    return $self->{RANGE};
}

sub help {
    my $self  = shift;
    my $value = shift;

    assert(defined($self));

    if (defined($value)) {
        $self->{HELP} = $value;
    }

    return $self->{HELP};
}

sub m4ify_hierarchical_indent ($)
{
    my $self = shift;

    assert(defined($self));

    return "  ";
}

#
# M4 related methods
#

sub m4ify_linear_body ($$)
{
    my $self   = shift;
    my $prefix = shift;

    assert(defined($self));
    assert(defined($prefix));
    assert(defined($self->id()));

    return
        $prefix .
        "CT_UI_MENU_DATA([" .
        $self->id() .
        "])\n";
}

sub m4ify_hierarchical_header ($$)
{
    my $self   = shift;
    my $prefix = shift;

    assert(defined($self));
    assert(defined($prefix));
    assert(defined($self->id()));
    assert(defined($self->label()));

    return
        $prefix .
        "CT_UI_MENU_WIDGET([". $self->id() .
        "],[" .
        $self->label() .
        "],[\n";
}

sub m4ify_hierarchical_footer ($$)
{
    my $self   = shift;
    my $prefix = shift;

    assert(defined($self));
    assert(defined($prefix));

    return $prefix . "])\n";
}

1;