diff options
author | castaway <castaway@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2008-08-17 15:51:43 +0000 |
---|---|---|
committer | castaway <castaway@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2008-08-17 15:51:43 +0000 |
commit | f1cd5548dac21719deb3412fbc5d8dadb9338cc3 (patch) | |
tree | ac9450f31f8b6b6477cd8ad2c60e4ba5dd72eddc /lib/Reaction/UI/View.pm | |
parent | d325256fd72c7a7c0af45e860f6d8d510b4682f2 (diff) | |
download | reaction-f1cd5548dac21719deb3412fbc5d8dadb9338cc3.tar.gz reaction-f1cd5548dac21719deb3412fbc5d8dadb9338cc3.zip |
Much documentation updates
Diffstat (limited to 'lib/Reaction/UI/View.pm')
-rw-r--r-- | lib/Reaction/UI/View.pm | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/lib/Reaction/UI/View.pm b/lib/Reaction/UI/View.pm index db95e7b..5158429 100644 --- a/lib/Reaction/UI/View.pm +++ b/lib/Reaction/UI/View.pm @@ -125,5 +125,104 @@ sub layout_set_args_for { __PACKAGE__->meta->make_immutable; +=pod + +=head1 NAME + +Reaction::UI::View - Render the UI. + +=head1 SYNOPSIS + + package MyApp::View::TT; + use base 'Reaction::UI::View::TT'; + + __PACKAGE__->config( + skin_name => 'MyApp', + ); + + ## In the Window class: + $res->body($self->view->render_window($self)); + +=head1 DESCRIPTION + +Render the viewports in the current window using the chosen skin and +layoutset, via the matching widgets. + +See also: + +=over + +=item L<Reaction::UI::Controller::Root> +=item L<Reaction::UI::ViewPort> +=item L<Reaction::UI::Window> +=item L<Reaction::UI::LayoutSet> +=item L<Reaction::UI::Widget> + +=back + +=head1 ATTRIBUTES + +=head2 app + +=over + +=item Arguments: $app? + +=back + +The application L<Catalyst> class. This is set at +L<Catalyst/COMPONENT> time for you. + +=head2 skin_name + +=over + +=item Arguments: $skinname? + +=back + +The name of the skin to use to render the pages. This should be the +name of a subdirectory under the F<share/skin> in your application +directory. The default skin name is C<default>, the default skin is +provided with Reaction. + +See also: L<Reaction::UI::Skin> + +=head2 skin + +=over + +=item Arguments: $skin? + +=back + +A L<Reaction::UI::Skin> object based on the L</skin_name>. It will be +created for you if not provided. + +=head2 layout_set_class + +The class of the L<Reaction::UI::LayoutSet> used to layout the +view. Defaults to searching down the precedence tree of the View class +looking for a class of the same name with C<View> replaced with +C<LayoutSet>. + +=head2 rendering_context_class + +The class of the L<Reaction::UI::RenderingContext> used to layout the +view. Defaults to searching down the precedence tree of the View class +looking for a class of the same name with C<View> replaced with +C<RenderingContext>. + +=head1 METHODS + +=head1 AUTHORS + +See L<Reaction::Class> for authors. + +=head1 LICENSE + +See L<Reaction::Class> for the license. + +=cut 1; |