Changeset 150 for trunk/SRC/ToBeReviewed/WIDGET/COMPOUND_WIDGET/cw_droplist_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_droplist_pm.pro (modified) (2 diffs)

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

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-;+
-; NAME: cw_droplist_pm
-;
-; PURPOSE: widget equivalent a WIDGET_DROPLIST 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_droplist_pm(parent)
-; 
-; INPUTS:
-;         Parent: The widget ID of the parent widget.
-;
-; KEYWORD PARAMETERS:tous ceux de WIDGET_DROPLIST
-;
-; 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 Droplist Widgets
-;
-;   Pressing the mouse button while the mouse cursor is over an
-;   element of a droplist widget causes the widget to change the label
-;   on the droplist button and to generate an event. The appearance of
-;   any previously selected element is restored to normal at the same
-;   time. The event structure returned by the WIDGET_EVENT function is
-;   defined by the following statement:
-;
-;   { CW_DROPLIST_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
-;
-;   The first three fields are the standard fields found in every
-;   widget event.
-;   INDEX returns the index of the selected item. This can be used to
-;   index the array of names originally used to set the widget''s
-;   value
-;   OUT:c''est un entier qui peut prendre 3 valeurs:
-;       1 : si on appuie sur + alors que l''index est deja aux max. rq:
-;       ds ce cas l''index reste au max
-;       -1: si on appuie sur - alors que l''index est deja aux min. rq:
-;       ds ce cas l''index 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 3 elements dont
-;   les noms sont inspires des mots cles que l''on peut passer a
-;   widget_control qd on utilise WIDGET_DROPLIST:
-;            DROPLIST_NUMBER: the number of elements currently
-;            contained in the specified droplist widget.
-;            DROPLIST_SELECT: the zero-based number of the
-;            currently-selected element (i.e., the currently-displayed
-;            element) in the specified droplist widget.
-;            DYNAMIC_RESIZE: a True value (1) if the widget specified
-;            by Widget_ID is a button, droplist, or label widget that
-;            has had its DYNAMIC_RESIZE attribute set. Otherwise,
-;            False (0) is returned.
-;       2) SET_VALUE
-;   widget_control,wid_id,set_value=impose
-;   permet de modifier l''etat de la droplist comme on peut le faire
-;   pour WIDGET_DROPLIST Impose peut etre:
-;       a) The contents of the list widget (string or string array)
-;       b) une structure qui peut avoir comme elements (de 1 a 3):
-;            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
-;            or deactivate (if set to 0) dynamic resizing of the
-;            specified CW_DROPLIST_PM widget (see the documentation
-;            for the DYNAMIC_RESIZE keyword to WIDGET_DROPLIST
-;            procedure for more information about dynamic widget
-;            resizing).
-;            DROPLIST_SELECT:Set this keyword to return the zero-based
-;            number of the currently-selected element (i.e., the
-;            currently-displayed element) in the specified droplist
-;            widget.
-;            VALUE: The contents of the list widget (string or string
-;            array)
-;
-; RESTRICTIONS:
-;
-; EXAMPLE: cf utiliser le programme founit i-dessous: testwid et la
-; procedure associee, testwid_event.
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      6/9/1999
-;
-;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ; PRO testwid_event, event
 ; ;   help, event, /STRUCT
@@ -199 +101 @@
 end
 ;----------------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;+
+;
+; @file_comments
+; Like WIDGET_DROPLIST 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 COLUMN
+; Buttons will be arranged in the number of columns
+; specified by this keyword.
+; 
+; @keyword ROW
+; Buttons will be arranged in the number of rows
+; specified by this keyword.
+; 
+; @keyword UVALUE
+; The user value to be associated with the widget.
+; 
+; @keyword UNAME
+; The user name to be associated with the widget.
+; 
+; @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 Droplist Widgets
+;
+;   Pressing the mouse button while the mouse cursor is over an
+;   element of a droplist widget causes the widget to change the label
+;   on the droplist button and to generate an event. The appearance of
+;   any previously selected element is restored to normal at the same
+;   time. The event structure returned by the WIDGET_EVENT function is
+;   defined by the following statement:
+;
+;   { CW_DROPLIST_PM, ID:0L, TOP:0L, HANDLER:0L, INDEX:0L, OUT:0 }
+;
+;   The first three fields are the standard fields found in every
+;   widget event.
+;   INDEX returns the index of the selected item. This can be used to
+;   index the array of names originally used to set the widget''s
+;   value
+;   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
+;   Send back, in the result variable, a structure of 3 elements whose 
+;   names are inspired by keywords we can pass at widget_control when
+;   we use WIDGET_COMBOBOX:
+;            DROPLIST_NUMBER: the number of elements currently
+;            contained in the specified droplist widget.
+;            DROPLIST_SELECT: the zero-based number of the
+;            currently-selected element (i.e., the currently-displayed
+;            element) in the specified droplist widget.
+;            DYNAMIC_RESIZE: a True value (1) if the widget specified
+;            by Widget_ID is a button, droplist, or label widget that
+;            has had its DYNAMIC_RESIZE attribute set. Otherwise,
+;            False (0) is returned.
+;       2) SET_VALUE
+;   widget_control,wid_id,set_value=impose
+;   permet de modifier l''etat de la droplist comme on peut le faire
+;   pour WIDGET_DROPLIST Impose peut etre:
+;       a) The contents of the list widget (string or string array)
+;       b) A structure which can have for elements (from 1 to 3): 
+;            DYNAMIC_RESIZE:Set this keyword to activate (if set to 1)
+;            or deactivate (if set to 0) dynamic resizing of the
+;            specified CW_DROPLIST_PM widget (see the documentation
+;            for the DYNAMIC_RESIZE keyword to WIDGET_DROPLIST
+;            procedure for more information about dynamic widget
+;            resizing).
+;            DROPLIST_SELECT:Set this keyword to return the zero-based
+;            number of the currently-selected element (i.e., the
+;            currently-displayed element) in the specified droplist
+;            widget.
+;            VALUE: The contents of the list widget (string or string
+;            array)
+;
+; @examples
+; See the program provided above (testwid and the associated procedure, testwid_event).
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                      6/9/1999
+;
+; @version
+; $Id$
+;
+;-
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
 FUNCTION cw_droplist_pm, parent,UVALUE = uvalue, UNAME = uname, ROW = row, COLUMN = column, _extra = ex
 ;