Difference between revisions of "API:EPrints/Box"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|Box]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
'''EPrints::Box''' - Class to render cute little Web 2.0ish boxes.
 
  
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
This just provides a function to render boxes in the EPrints style.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_render -->==render==
 
 
  $box_xhtmldom = EPrints::Box::render( %options )
 
 
Render a cute box.
 
 
Options:
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_session -->==session==
 
 
  session: Current $session (required)
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_box -->==box==
 
 
  id: XML ID of box (required)
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_title -->==title==
 
 
  title: XHTML DOM of title (required). Nb. Will not be cloned.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_content -->==content==
 
 
  content: XHTML DOM of content (required). Nb. Will not be cloned.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_collapsed_boolean_default_to_false -->==collapsed_boolean_default_to_false==
 
 
  collapsed: boolean. Default to false.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px -->==content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px==
 
 
  content-style: the css style to apply to the content box. For example; "overflow-y: auto; height: 300px;"
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and -->==show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and==
 
 
  show_icon_url and hide_icon_url: the icons to show instead of the default [+] and [-]
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Revision as of 15:40, 12 August 2009