Infobox: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
imported>Jeremy
 
Line 20: Line 20:
* '''figurename''': [{'Information'}] default name of infobox figure.
* '''figurename''': [{'Information'}] default name of infobox figure.
* '''maxsize''': [width height] maximum default size of window in characters.
* '''maxsize''': [width height] maximum default size of window in characters.
* '''fontname''': [{''}| fontname ] default font for listbox (empty = use system default).
* '''fontname''': [{<nowiki>''</nowiki>}| fontname ] default font for listbox (empty = use system default).
* '''fontsize''': [{[]}| fontsize ] default font size for listbox (empty = use system default).
* '''fontsize''': [{[]}| fontsize ] default font size for listbox (empty = use system default).
* '''visible''': [{'on'}| 'off'] visibility of new infobox figures.
* '''visible''': [{'on'}| 'off'] visibility of new infobox figures.
* '''openmode''': [{'reuse'}| 'new' ] reuse existing infobox figure or create a new figure.
* '''openmode''': [{'reuse'}| 'new' ] reuse existing infobox figure or create a new figure.
* '''helplink''': [''] URL or Wiki page to show when user clicks on Help menu.
* '''helplink''': [<nowiki>''</nowiki>] URL or Wiki page to show when user clicks on Help menu.

Latest revision as of 09:55, 10 October 2011

Purpose

Display a text message in an information box.

Synopsis

fig = infobox(string,options)
infobox(fig,'string',string)
infobox(fig,'font',fontname,fontsize)
infobox(fig,'name',figurename)

Description

When called with a string input (string), infobox creates a figure with a scrollable listbox. The contents of the listbox can be copied to the system clipboard for pasting into other programs. The output of infobox is (fig) the handle of the newly created figure.

Options

options = a structure array with the following fields:

  • figurename: [{'Information'}] default name of infobox figure.
  • maxsize: [width height] maximum default size of window in characters.
  • fontname: [{''}| fontname ] default font for listbox (empty = use system default).
  • fontsize: [{[]}| fontsize ] default font size for listbox (empty = use system default).
  • visible: [{'on'}| 'off'] visibility of new infobox figures.
  • openmode: [{'reuse'}| 'new' ] reuse existing infobox figure or create a new figure.
  • helplink: [''] URL or Wiki page to show when user clicks on Help menu.