Current File : //opt/RZphp74/includes/Gtk/Styled/VAdjustment.php

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4                                                        |
// +----------------------------------------------------------------------+
// | Copyright (c) 2005 Scott Mattocks                                    |
// +----------------------------------------------------------------------+
// | This source file is subject to version 3.0 of the PHP license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available through the world-wide-web at the following url:           |
// | http://www.php.net/license/3_0.txt.                                  |
// | If you did not receive a copy of the PHP license and are unable to   |
// | obtain it through the world-wide-web, please send a note to          |
// | license@php.net so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Author: Scott Mattocks <scottmattocks@php.net>                       |
// +----------------------------------------------------------------------+
//
// $Id: VAdjustment.php,v 1.2 2005/01/11 13:55:04 scottmattocks Exp $
/**
 * A vertical styleable adjustment pseudo widget.
 *
 * This adjustments bar moves from up and down when the value
 * is changed. All components are packed into a vBox.
 *
 * This class inherits from Gtk_Styled_Adjustment.
 *
 * @author     Scott Mattocks <scottmattocks@php.net>
 * @version    @VER@
 * @category   Gtk
 * @package    Gtk_Styled
 * @subpackage Adjustment
 * @license    PHP version 3.0
 * @copyright  Copyright &copy; 2005 Scott Mattocks
 * @see        Gtk_Styled_Adjustment
 */
require_once 'Gtk/Styled/Adjustment.php';
class Gtk_Styled_VAdjustment extends Gtk_Styled_Adjustment {

    function &_getTrackContainer()
    {
        $container =& new GtkVBox;
        $container->set_usize($this->width, $this->pageSize);
        
        return $container;
    }

    /**
     * Set the size of the bar.
     *
     * The bar size is configurable. Depending on how the adjustment is 
     * used, the bar size may depend entirely on its value or it may 
     * change with respect to its environment. If the adjustment is used
     * as a progress bar, the size of the bar is directly related to the
     * percentage of the task that is complete. If the adjustment is used
     * as a scroll bar, the size of the bar is related to the amount of
     * the scrolling widget that is currently show compared to its total
     * size.
     *
     * @access private
     * @param  none
     * @return void
     */
    function _setBarSize()
    {
        if ($this->pageSize >= $this->upper) {
            $this->bar->set_usize(-1, $this->widget->allocation->height);
            $this->postTrack->set_usize(-1, 0);
        } else {
            $ts = $this->widget->allocation->height;
            $this->bar->set_usize(-1, $ts * ($this->pageSize / $this->upper));
        }
    }

    /**
     * Set the bars position within the track.
     *
     * Set the starting position of the bar with in the track. The bar
     * cannot start (length of track) - (length of bar). The position 
     * of the bar is mostly only relavent when the adjustment is being
     * used as a scroll bar or when being used as an activity progress
     * indicator.
     *
     * The bar position is determined by the width/height of the event
     * box that preceeds the bar.
     *
     * @access private
     * @param  none
     * @return void
     */
    function _setBarPosition()
    {
        // tb = Top of Bar
        $tb = ceil($this->value * (($this->widget->allocation->height) / $this->upper));
        $this->preTrack->set_usize(-1, $tb);
    }

    /**
     * Get the adjustment value based on a new bar position.
     *
     * Sometimes it is necessary to first set the position of the bar
     * and then the value of the adjustment. This method calculates the
     * value based on the current bar position and a change in the bar's
     * position. This method is mostly used for dragging the bar within
     * the track while scrolling.
     *
     * @access public
     * @param  double $changeInPosition The amount the position should change
     * @return double
     */
    function getValueFromPosition($changeInPosition)
    {
        // tbc = Top of Bar Current
        $tbc   = $this->preTrack->allocation->height;
        $value = ($tbc + $changeInPosition) / (($this->widget->allocation->height) / $this->upper); 

        return $value;
    }

    /**
     * Set the size of the entire track.
     *
     * Sets the size of the entire track. The track contains the preTrack
     * the bar and the postTrack.
     *
     * @access   private
     * @param    none
     * @return   void
     */
    function _setTrackSize()
    {
        if (isset($this->widget->allocation->height)) {
            $this->track->set_usize($this->width, $this->widget->allocation->height);
        }
    }

    /**
     * Check to see that the mouse is within the boundries of the
     * bar.
     *
     * Check the current mouse position to see if it is within
     * the bounds of the adjustment bar. It is only necessary to
     * check if the mouse is with in one direction of the bar's
     * alloted space. For example, we only care if the mouse is
     * within the y-range of a vertical adjustment.
     *
     * @abstract
     * @access   public
     * @param    none
     * @return   boolean
     */
    function checkMouseBounds()
    {
        $pointer = $this->widget->window->pointer;
        $bar     = $this->widget->allocation;

        if ($pointer[1] > $bar->y + $bar->height) {
            return false;
        } elseif ($pointer[1] < $bar->y) {
            return false;
        } else {
            return true;
        }
    }
}
/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 */
?>