[Jifty-commit] r6154 - in jifty/trunk: lib/Jifty/Web/Form

Jifty commits jifty-commit at lists.jifty.org
Wed Dec 17 15:19:55 EST 2008


Author: alexmv
Date: Wed Dec 17 15:19:54 2008
New Revision: 6154

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Web/Form/Clickable.pm

Log:
 r40097 at kohr-ah:  chmrr | 2008-12-17 15:19:40 -0500
  * Small doc fixups


Modified: jifty/trunk/lib/Jifty/Web/Form/Clickable.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Clickable.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Clickable.pm	Wed Dec 17 15:19:54 2008
@@ -16,6 +16,8 @@
 
 use base 'Jifty::Web::Form::Element';
 
+=head1 METHODS
+
 =head2 accessors
 
 Clickable adds C<url>, C<escape_label>, C<continuation>, C<call>,
@@ -239,51 +241,48 @@
     return $self;
 }
 
-=head2 url
+=head2 url [VALUE]
 
-Sets the page that the user will end up on after they click the
-button.  Defaults to the current page.
+Gets or sets the page that the user will end up on after they click
+the button.  Defaults to the current page.
 
-=head2 label
+=head2 label [VALUE]
 
-The text on the clickable object.
+Gets or sets the text on the clickable object.
 
-=head2 escape_label
+=head2 escape_label [VALUE]
 
-If set to true, HTML escapes the content of the label before
-displaying it.  This is only relevant for objects that are rendered as
-HTML links.  The default is true.
+Gets or sets if the label is escaped.  This is only relevant for
+objects that are rendered as HTML links.  The default is true.
 
-=head2 continuation
+=head2 continuation [VALUE]
 
-The current continuation for the link.  Defaults to the current
-continuation now, if there is one.  This may be either a
+Gets or sets the current continuation for the link.  Defaults to the
+current continuation now, if there is one.  This may be either a
 L<Jifty::Continuation> object, or the C<id> of such.
 
-=head2 call
+=head2 call [VALUE]
 
-The continuation to call when the link is clicked.  This will happen
-after actions have run, if any.  Like C<continuation>, this may be a
-L<Jifty::Continuation> object or the C<id> of such.
+Gets or sets the continuation to call when the link is clicked.  This
+will happen after actions have run, if any.  Like C<continuation>,
+this may be a L<Jifty::Continuation> object or the C<id> of such.
 
-=head2 returns
+=head2 returns [VALUE]
 
-Passing this parameter implies the creation of a continuation when the
-link is clicked.  It takes an anonymous hash of return location to
-where the return value is pulled from.  See L<Jifty::Request::Mapper>
-for details.
+Gets or sets the return value mapping from the continuation.  See
+L<Jifty::Request::Mapper> for details.
 
-=head2 submit
+=head2 submit [VALUE]
 
-A list of actions to run when the object is clicked.  This may be an
-array refrence or a single element; each element may either be a
-moniker or a L<Jifty::Action>.  An undefined value submits B<all>
-actions in the form, an empty list reference (the default) submits
-none.
+Gets or sets the list of actions to run when the object is clicked.
+This may be an array refrence or a single element; each element may
+either be a moniker or a L<Jifty::Action>.  An undefined value submits
+B<all> actions in the form, an empty list reference (the default)
+submits none.
 
-=head2 preserve_state
+=head2 preserve_state [VALUE]
 
-A boolean; whether state variables are preserved across the link.
+Gets or sets whether state variables are preserved across the link.
 Defaults to true if there are any AJAX actions on the link, false
 otherwise.
 
@@ -418,7 +417,8 @@
 
 =head2 post_parameters
 
-The hash of parameters as they would be needed on a POST request.
+Returns the hash of parameters as they would be needed on a POST
+request.
 
 =cut
 
@@ -455,7 +455,8 @@
 
 =head2 get_parameters
 
-The hash of parameters as they would be needed on a GET request.
+Returns the hash of parameters as they would be needed on a GET
+request.
 
 =cut
 


More information about the Jifty-commit mailing list