merge docs for action viewport roles
matthewt [Fri, 22 Aug 2008 18:29:51 +0000 (18:29 +0000)]
lib/Reaction/UI/ViewPort/Action/Role/Apply.pm
lib/Reaction/UI/ViewPort/Action/Role/Close.pm
lib/Reaction/UI/ViewPort/Action/Role/OK.pm

index 4138dde..e65b9e7 100644 (file)
@@ -27,3 +27,45 @@ sub apply {
 around accept_events => sub { ( 'apply', shift->(@_) ) };
 
 1;
+
+__END__
+
+=head1 NAME
+
+Reaction::UI::ViewPort::Action::Role::Apply
+
+=head1 ATTRIBUTES
+
+=head2 apply_label
+
+Default: 'apply'
+
+=head2 on_apply_callback
+
+CodeRef.
+
+=head1 METHODS
+
+=head2 can_apply
+
+=head2 apply
+
+Calls a user-supplied C<do_apply> and if it is successful runs the
+C<on_apply_callback> passing C<$self> and the result of C<do_apply> as args.
+
+=head1 SEE ALSO
+
+L<Reaction::UI::ViewPort::Action::Role::Close>
+
+L<Reaction::UI::ViewPort::Action::Role::OK>
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut
+
index ad31722..f236a9d 100644 (file)
@@ -37,3 +37,51 @@ around accept_events => sub {
 };
 
 1;
+
+__END__
+
+=head1 NAME
+
+Reaction::UI::ViewPort::Action::Role::Close
+
+=head1 ATTRIBUTES
+
+=head2 close_label
+
+Default: C<close_label_close>
+
+=head2 close_label_close
+
+Default: 'close'
+
+=head2 close_label_cancel
+
+This label is only shown when C<changed> is true.
+
+Default: 'cancel'
+
+=head2 on_close_callback
+
+CodeRef.
+
+=head1 METHODS
+
+=head2 close
+
+=head2 can_close
+
+=head1 SEE ALSO
+
+L<Reaction::UI::ViewPort::Action::Role::Apply>
+
+L<Reaction::UI::ViewPort::Action::Role::OK>
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut
index 59e96c7..38001f8 100644 (file)
@@ -20,3 +20,37 @@ around accept_events => sub {
 };
 
 1;
+
+__END__
+
+=head1 NAME
+
+Reaction::UI::ViewPort::Action::Role::Close
+
+=head1 ATTRIBUTES
+
+=head2 ok_label
+
+Default: 'ok'
+
+=head1 METHODS
+
+=head2 ok
+
+Calls C<apply>, and then C<close> if successful.
+
+=head1 SEE ALSO
+
+L<Reaction::UI::ViewPort::Action::Role::Apply>
+
+L<Reaction::UI::ViewPort::Action::Role::Close>
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut