Changeset 150 for trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slider_pm.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slider_pm.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_slider_pm.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-;+
-; NAME: cw_slider_pm
-;
-; PURPOSE: widget equivalent a WIDGET_SLIDER sauf qu'en plus on
-; dispose de 2 bouttons + et - pour deplacer le widget de +/- 1.
-;
-; CATEGORY: compound widget (aide a l''ecriture des widgets)
-;
-; CALLING SEQUENCE: id=cw_slider_pm(parent)
-; 
-; INPUTS:
-;         Parent: The widget ID of the parent widget.
-;
-; KEYWORD PARAMETERS:tous ceux de WIDGET_SLIDER
-;
-; OUTPUTS:
-;         The returned value of this function is the widget ID of the
-;         newly-created animation widget.
-;
-; COMMON BLOCKS: none
-;
-; SIDE EFFECTS: 
-;
-;  Widget Events Returned by the CW_SLIDER_PM Widget
-;
-;  Slider widgets generate events when the mouse is used to change
-;  their value. The event structure returned by the WIDGET_EVENT
-;  function is defined by the following statement:
-;
-;  {CW_SLIDER_PM, ID:0L, TOP:0L, HANDLER:0L, VALUE:0L, DRAG:0, OUT:0}
-;
-;  ID is the widget ID of the button generating the event. TOP is the
-;  widget ID of the top level widget containing ID.
-;  HANDLER contains the widget ID of the widget associated with the
-;  handler routine.
-;  VALUE returns the new value of the slider.
-;  DRAG returns integer 1 if the slider event was generated as part of
-;  a drag operation, or zero if the event was generated when the user
-;  had finished positioning the slider. Note that the slider widget
-;  only generates events during the drag operation if the DRAG keyword
-;  is set, and if the application is running under Motif. When the
-;  DRAG keyword is set, the DRAG field can be used to avoid
-;  computationally expensive operations until the user releases the
-;  slider.
-;  OUT:c''est un entier qui peut prendre 3 valeurs:
-;      1 : si on appuie sur + alors que le slider est deja aux max. rq:
-;      ds ce cas le slider reste au max
-;      -1: si on appuie sur - alors que le slider est deja aux min. rq:
-;      ds ce cas le slider reste au min
-;      0 : ds les autres cas!
-;
-;   Keywords to WIDGET_CONTROL
-;
-;   A number of keywords to the WIDGET_CONTROL procedure affect the
-;   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
-;       1) GET_VALUE
-;   widget_control,wid_id,get_value=resultat
-;   retourne ds la variable resultat une structure de 2 elements dont
-;   les noms sont inspires des mots cles que l''on peut passer a
-;   widget_control qd on utilise WIDGET_SLIDER:
-;            VALUE:the value setting of the widget
-;            SLIDER_MIN_MAX: a 2 elements array: The minimum and the
-;            maximum value of the range encompassed by the slider
-;       2) SET_VALUE
-;   widget_control,wid_id,set_value=impose
-;   permet de modifier l''etat de la slider bar comme on peut le faire
-;   pour WIDGET_SLIDER. Impose peut etre:
-;       a) un entier: donne la nouvelle  position of the slider.
-;       b) une structure qui peut avoir comme elements (de 1 a 3):
-;            VALUE:un entier qui donne la nouvelle  position of the slider.
-;            SLIDER_MIN:Set to a new minimum value for the specified
-;            slider widget.
-;            SLIDER_MAX:Set to a new minimum value for the specified
-;            slider widget.
-;
-; RESTRICTIONS:
-;
-; EXAMPLE: cf utiliser le programme founit i-dessous: testwid et la
-; procedure associee, testwid_event.
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      5/9/1999
-;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ; PRO testwid_event, event
 ; ;   help, event, /STRUCT
@@ -249 +160 @@
 end
 ;----------------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;+
+;
+; @file_comments
+; Like WIDGET_SLIDER but here, their are 2 buttons + and - to move the widget from +/- 1
+;
+; @categories
+; compound widget
+; 
+; @param PARENT {in}{required}
+; The widget ID of the parent widget.
+;
+; @keyword UVALUE
+; The user value to be associated with the widget.
+; 
+; @keyword UNAME
+; The user name to be associated with the widget.
+; 
+; @keyword VALUE
+;
+;
+; @keyword MAXIMUM
+; 
+; 
+; @keyword MINIMUM
+;
+; 
+; @keyword STRMINLEN
+;
+;
+; @keyword _EXTRA
+; Used to pass your keywords
+;
+; @returns
+; The returned value of this function is the widget ID of the
+; newly-created animation widget.
+;
+; @restrictions
+;
+;  Widget Events Returned by the CW_SLIDER_PM Widget
+;
+;  Slider widgets generate events when the mouse is used to change
+;  their value. The event structure returned by the WIDGET_EVENT
+;  function is defined by the following statement:
+;
+;  {CW_SLIDER_PM, ID:0L, TOP:0L, HANDLER:0L, VALUE:0L, DRAG:0, OUT:0}
+;
+;  ID is the widget ID of the button generating the event. TOP is the
+;  widget ID of the top level widget containing ID.
+;  HANDLER contains the widget ID of the widget associated with the
+;  handler routine.
+;  VALUE returns the new value of the slider.
+;  DRAG returns integer 1 if the slider event was generated as part of
+;  a drag operation, or zero if the event was generated when the user
+;  had finished positioning the slider. Note that the slider widget
+;  only generates events during the drag operation if the DRAG keyword
+;  is set, and if the application is running under Motif. When the
+;  DRAG keyword is set, the DRAG field can be used to avoid
+;  computationally expensive operations until the user releases the
+;  slider.
+;  OUT:It is an integer which can take 3 values: 
+;       1 : If we press + when the index is already at the max
+;       Comment: In this case, the index stay at the max
+;       -1: If we press - when the index is already at the min
+;       Comment: In this case, the index stay at the min
+;       0 : In other cases
+;
+;   Keywords to WIDGET_CONTROL
+;
+;   A number of keywords to the WIDGET_CONTROL procedure affect the
+;   behavior of cw_slider_pm widget: GET_VALUE and SET_VALUE.
+;       1) GET_VALUE
+;   widget_control,wid_id,get_value=resultat
+;   retourne ds la variable resultat une structure de 2 elements dont
+;   les noms sont inspires des mots cles que l''on peut passer a
+;   widget_control qd on utilise WIDGET_SLIDER:
+;            VALUE:the value setting of the widget
+;            SLIDER_MIN_MAX: a 2 elements array: The minimum and the
+;            maximum value of the range encompassed by the slider
+;       2) SET_VALUE
+;   widget_control,wid_id,set_value=impose
+;   Allows to modify the state of the combobox like we can do it for 
+;   WIDGET_COMBOBOX. May impose: 
+;       a) un entier: donne la nouvelle  position of the slider.
+;       b) A structure which can have for elements (from 1 to 3): 
+;            VALUE: an integer which give the new position of the slider
+;            SLIDER_MIN:Set to a new minimum value for the specified
+;            slider widget.
+;            SLIDER_MAX:Set to a new minimum value for the specified
+;            slider widget.
+;
+;
+; @examples
+; See the program provided above (testwid and the associated procedure, testwid_event).
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                      5/9/1999
+;
+; @version
+; $Id$
+;
+; @todo
+; seb: documenter
+;
+;-
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
 FUNCTION cw_slider_pm, parent, MAXIMUM = maximum, MINIMUM = minimum $
                        , STRMINLEN = strminlen, VALUE = value, UVALUE = uvalue $