---

channel_type Class Reference

A class to hold a description of a channel. More...

#include <channel_type.h>

List of all members.

Public Methods
	channel_type (bool initialize_to_illegal_values=TRUE)
	Constructor.
	~channel_type ()
	Destructor.
Public Attributes
wxString	configuration_section
	The channels section in the section in config file stored.
wxString	doc_name
	Name of the channel, as appearing in main_listctrl and the viewer's library.
wxString	home_url
	The starting page of the channel.
long	depth_first
	TRUE to spider depth-first instead of breadth first.
long	verbosity
	Amount of messages generated by the parser.
long	status_line_length
wxString	command_before
	Command executed before parsing this channel.
wxString	command_after
	Command execute after parsing this channel.
long	home_maxdepth
	Maximum depth to spider. 1=starting page only.
long	home_stayonhost
	TRUE is to not leave the hostname of the starting page.
long	home_stayondomain
	TRUE is to not leave the second level domain of the starting page.
wxString	home_url_pattern
	A regex pattern that must be matched for the page/image to be retreived.
wxString	charset
	Character set of the channel.
long	indent_paragraphs
	TRUE if paragraphs should be indented.
long	bpp
	Image depth for images. 0=no images.
long	alt_text
	TRUE to include alt tags for images not included in the output.
long	maxheight
	Mamimum height of an inline image (if higher than this, optionally linked to fullsize.
long	maxwidth
	Mamimum width of an inline image (if higher than this, optionally linked to fullsize.
long	alt_maxheight
	Mamimum height of an fullsize image that is linked from its thumbnail.
long	alt_maxwidth
	Mamimum width of an fullsize image that is linked from its thumbnail.
long	image_compression_limit
	Image file size must exceed this number of bytes for it to warrant oompression.
long	try_reduce_bpp
	Images must be <60000 bytes to fit in viewer. TRUE to reduce bpp to fit under 60000 bytes.
long	try_reduce_dimension
	Images must be <60000 bytes to fit in viewer. TRUE to reduce dimensions to fit 60000 bytes.
wxString	compression
	Type of compression, either doc, or zlib.
wxString	category
	Delimited string array of categories for output file to be placed, in handheld viewer.
long	no_urlinfo
	TRUE to remove the url info from each page for security and/or smaller size.
wxString	owner_id_build
	A security measure for documents, owner_id_build must match the viewer's username.
long	copyprevention_bit
	TRUE to prevent beaming of the output among handhelds.
long	backup_bit
	TRUE to archive a copy of the output from viewer onto the desktop computer.
long	launchable_bit
	TRUE to make the output launchable from the viewer's Launcher screen.
wxString	big_icon
	Fullname to an icon file to overrride the default large icon in Launcher.
wxString	small_icon
	Fullname to an icon file to overrride the default large icon in Launcher.
wxString	doc_file
	Fullname of the output file.
wxString	user
	Handheld username to install the output to during a sync (if OS supports it).
wxString	copy_to_dir
	Directory to copy output to.
long	update_frequency
	The number of periods between each update. Example: the '3' in '3 days'.
wxString	update_period
	The period of updates. Example: the 'days' in '3 days'.
wxDateTime	update_base
	A base datetime at which start counting update_periods from, to calculate if due.
long	update_enabled
	TRUE if updates are enabled for this channel.

---

Detailed Description

A class to hold a description of a channel.

Members name and role match up with commandline plucker and the plucker configuration file names, where applicable.

All public members, so can just get/set one whenever desired.

Note:

Bools are longs, so that they can store a -1 value.

Todo:

Add anchor_color parameter, and any others.

---

Constructor & Destructor Documentation

channel_type::channel_type (  bool    initialize_to_illegal_values = TRUE )

Constructor. Parameters: initialize_to_illegal_values  TRUE to put an illegal value in each member (such a -1 in a switch that is usually 0 or 1. This allows us to track whether each item was actually set by something to 0 or 1-- otherwise wouldn't know if it started at 0, or something specifically said that is should be 0.

---

Member Data Documentation

wxString channel_type::big_icon

Fullname to an icon file to overrride the default large icon in Launcher. Only noticable if launchable_bit=TRUE. Incorrectly sized bitamps will be resized as needed.

wxString channel_type::configuration_section

The channels section in the section in config file stored. Will also be the directory name in the /channels directory that the channel is stored in.

wxString channel_type::doc_file

Fullname of the output file. May include a plucker: protocol prefix to specify relative location to pluckerhome. Currently autogenerated by Plucker Desktop as to be the same as the section name, to prevent clashes of similarly named files when try to put two files of the same name onto the handheld, since on MSW/Mac they are queued into a certain directory.

wxString channel_type::small_icon

Fullname to an icon file to overrride the default large icon in Launcher. Only noticable if launchable_bit=TRUE. Incorrectly sized bitamps will be resized as needed.

long channel_type::try_reduce_dimension

Images must be <60000 bytes to fit in viewer. TRUE to reduce dimensions to fit 60000 bytes. Can only use try_reduce_bpp or try_reduce_dimension. If specify both, only one will be used.