---

Defines: plkr prefixed
[Defines]

These defines can be found in plucker_defines.h . More...

Defines
#define	plkrAPPLICATION_DESKTOP_NAME_DEFAULT   _( "Plucker Desktop" )
	Name of the desktop application [default] only used in plkrAPPLICATION_DESKTOP_NAME.
#define	plkrAPPLICATION_SUITE_NAME_DEFAULT   _( "Plucker" )
	Name of the application suite [default] only used in plkrAPPLICATION_SUITE_NAME.
#define	plkrAPPLICATION_PUBLISHER_DEFAULT   _( "The Plucker Team" )
	Name of the publisher [default] only used in plkrAPPLICATION_PUBLISHER.
#define	plkrAPPLICATION_DESKTOP_NAME   the_configuration->Read( "/PLUCKER_DESKTOP/branding_application_desktop_name", plkrAPPLICATION_DESKTOP_NAME_DEFAULT )
	Name of the desktop application [reads from config file].
#define	plkrAPPLICATION_SUITE_NAME   the_configuration->Read( "/PLUCKER_DESKTOP/branding_application_suite_name", plkrAPPLICATION_SUITE_NAME_DEFAULT )
	Name of the application suite [reads from config file].
#define	plkrAPPLICATION_PUBLISHER   the_configuration->Read( "/PLUCKER_DESKTOP/branding_application_publisher", plkrAPPLICATION_PUBLISHER_DEFAULT )
	Name of the publisher [reads from config file.
#define	plkrPLUCKER_DESKTOP_VERSION_STRING   "1.2.0.8"
	Version of the application.
#define	plkrOS_DIR_SEPARATOR   '\\'
	The separator used for multiple directories in a key.
#define	plkrOS_FILE_ARRAY_SEPARATOR   ';'
	The separator used for multiple files in a key.
#define	plkrMAXIMUM_BASE_SECTION_LENGTH   25
	Length of a section name in characters before appending a unique number.
#define	plkrMAXIMUM_CHANNEL_NAME_LENGTH   26
	Maximum length of a channel name in characters.
#define	plkrNEW_CHANNEL_TEMPLATE_SECTION   "NEW_CHANNEL_TEMPLATE"
	Name of section to store the template for new channels.
#define	plkrUNNAMED_CHANNEL_NAME   _( "Unnamed channel" )
	Default name of channels that don't have a name yet.
#define	plkrRESERVED_CONFIGURATION_SECTIONS   "DEFAULT", "POSIX", "OS2" "WINDOWS", "MACINTOSH", "PLUCKER_DESKTOP", "PLUCKER_DAEMON", "CONTEXT_DEFAULT", plkrNEW_CHANNEL_TEMPLATE_SECTION
	Sections of the configuration file that aren't channels.
#define	plkrSHELL_COMMAND_REPLACEMENT_FILENAME   "plkrFILE"
	A placeholder in a user-entered command string that gets replaced with the filename.
#define	plkrFILE_FRIENDLY_DATETIME_STAMP   "plkrFILE_FRIENDLY_DATETIME_STAMP"
	A placeholder in a string that gets replaced with a file-friendly datetimestap.
#define	plkrEOL_CHARACTER   "\r\n"
	EOL (End Of Line) character used on the OS.
#define	plkrLISTCTRL_EXTRA_WIDTH_PADDING   9
	Number of pixels extra to leave besides the scrollbar width.
#define	plkrSTANDARD_SIZER_PADDING   5
	Normal number of pixels padding a control inside a sizer, in the xrc resources.
#define	plkrFIXED_PERCENTAGE_GAUGE_RANGE   1000
	A fiexed range value for gauges. Prevents flicker if need to change both range/value.
#define	plkrMINIMUM_WIZARD_WIDTH   320
	Minimum width in pixels of a wizard 'content' area.
#define	plkrMINIMUM_WIZARD_HEIGHT   250
	Minimum height in pixels of a wizard 'content' area.
#define	plkrHTML_TIP_DIALOG_CONTENT_WIDTH   300
	Width of the HTML content window component of a html_tip_dialog.
#define	plkrHTML_TIP_DIALOG_CONTENT_HEIGHT   250
	Width of the HTML content window component of a html_tip_dialog.
#define	plkrDEFAULT_TEXTCTRL_FONT_POINTSIZE   10
	The default size of a textctrl font if making a custom font.
#define	plkr_GUI_LIGHT_COLOR_RGB_STRING   "#3399CC"
	Usually use the OS's GUI color, elsewheree, this is the lighter color string to use.
#define	plkrGUI_ELEMENT_DARK_COLOR_RGB_STRING   "#333366"
	Usually use the OS's GUI color, elsewhere, this is the darker color string to use.
#define	plkrDATE_TIME_FORMAT   "%Y-%m-%dT%H:%M:%S"
	Date format to use. Example: 1994-11-05T08:15:30.
#define	plkrDATE_FORMAT   "%Y-%m-%d"
	The format of the component time. Example: 08:15:30.
#define	plkrTIME_FORMAT   "%H:%M:%S"
	The format of the component time. Example: 1994-11-05.
#define	plkrPRETTY_COMPACT_DATE_TIME_FORMAT   "%b %d %H:%M"
	A prettier version of DateTime, used only for display only.
#define	plkrAUTOUPDATE_DEFAULT_DEFERRED_LOWER_TIME_LIMIT   "19:00:00"
	Default value for the lower autoupdate limit,.
#define	plkrAUTOUPDATE_DEFAULT_DEFERRED_UPPER_TIME_LIMIT   "23:00:00"
	Default value for the upper autoupdate limit,.
#define	plkrSTARTUP_TIPS_STYLE_USER_DEFAULT   -1L
	Startup tips: use whatever type the user specified in their configuration.
#define	plkrINFINITE_STATUS_LINE_LENGTH_LENGTH   1000000L
	A high value for the status_line_length key. If equal to this value, unchecks control.
#define	plkrIMAGES_ONLY_THUMBNAIL   0L
	Image handling alt_maxwidth/alt_maxheight. Tells to only make a thumbnail, never link.
#define	plkrIMAGES_ALWAYS_LINK   1000000L
	Image handling alt_maxwidth/alt_maxheight. Tells to always link to the full-size one.
#define	plkrIMAGES_DEFAULT_MAXHEIGHT   250L
	Image handling: default maxheight before an image is thumbnailed.
#define	plkrIMAGES_DEFAULT_MAXWIDTH   150L
	Image handling: default maxwidth before an image is thumbnailed.
#define	plkrHELP_ID_ADD_CHANNEL_WIZARD   "Add Channel Wizard"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_ADD_CHANNEL_WIZARD_CHANNEL_NAME_PAGE   "Channel Name Page"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_ADD_CHANNEL_WIZARD_STARTING_PAGE_PAGE   "Starting Page Page"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_ADD_CHANNEL_WIZARD_LIMITS_PAGE   "Limits Page"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_ADD_CHANNEL_WIZARD_DESTINATION_PAGE   "Destination Page "
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_BODY_DIALOG   "Insert Body Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_BLOCKED_DIALOG   "Adding/Editing An Exclusion"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_BOOKMARK_DIALOG   "Insert Bookmark Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_START_TAB   "Starting Page Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_SPIDERING_TAB   "Spidering Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_LIMITS_TAB   "Limits Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_FORMATTING_TAB   "Formatting Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_IMAGES_TAB   "Images Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_OUTPUT_TAB   "Output Options Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_DESTINATION_TAB   "Destination Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_CHANNEL_DIALOG_SCHEDULING_TAB   "Scheduling Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_EDITOR_DIALOG   "Editor Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_EMAIL_DIALOG   "Insert Email Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_EXCLUSION_DIALOG   "Exclusion List Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_FONT_DIALOG   "Insert Font Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_HANDHELD_DEST_DIALOG   "Handheld Destination Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_HR_DIALOG   "Insert Horizontal Rule Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_HYPERLINK_DIALOG   "Insert Hyperlink Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_IMAGE_DIALOG   "Insert Image Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_INSTALL_VIEWER_WIZARD   "Install Handheld Software Wizard"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_INSTALL_VIEWER_WIZARD_SOFTWARE_SELECTION_PAGE   "Software Selection Page "
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_INSTALL_VIEWER_WIZARD_DESTINATION_PAGE   "Destination Page "
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_MAIN_DIALOG   "Main Dialog"
	Help identifier to look up this topic in the help_controller.
#define	plkrHELP_ID_OL_DIALOG   "Insert Ordered List Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_POPUP_DIALOG   "Insert Popup Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PREFERENCES_DIALOG_AUTOUPDATE_TAB   "Autoupdate Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PREFERENCES_DIALOG_EDITOR_TAB   "HTML Editor Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PREFERENCES_DIALOG_INTERFACE_TAB   "Interface Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PREFERENCES_DIALOG_SHOWCASE_TAB   "Showcase Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PREFERENCES_DIALOG_SPIDERING_TAB   "Spidering Tab "
	Help identifier to look up this topic in the help_controller (Note trailing space).
#define	plkrHELP_ID_PREFERENCES_DIALOG_PROXY_TAB   "Proxy Tab"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_PROGRESS_DIALOG   "Progress Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SHOWCASE_DIALOG   "Showcase Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SETUP_WIZARD   "Setup Wizard"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SETUP_WIZARD_SOFTWARE_SELECTION_PAGE   "Software Selection Page"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SETUP_WIZARD_DESTINATION_PAGE   "Destination Page"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SETUP_WIZARD_PROXY_PAGE   "Proxy Page"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_SPAN_DIALOG   "Insert Span Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_TABLE_DIALOG   "Insert Table Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_TD_TH_DIALOG   "Insert Table Cell Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrHELP_ID_UL_DIALOG   "Insert Unordered List Dialog"
	Help identifier to look up this topic in the help_controller .
#define	plkrMSW_MAXIMUM_NUMBER_OF_PROCESS_STILL_ACTIVE_CHECKS   10
	Number of times program will look for BMP2TMP still running, if feature enabled.
#define	plkrMSW_SLEEP_INTERVAL_BETWEEN_PROCESS_STILL_ACTIVE_CHECKS   1
	Seconds to sleep before checking again if BMP2TMP still running, if feature enabled.
Enumerations
enum	{   plkrAUTOUPDATE_MODE_NEVER = 0,   plkrAUTOUPDATE_MODE_IMMEDIATELY,   plkrAUTOUPDATE_MODE_DEFERRED,   plkrAUTOUPDATE_MODE_ON_SYNC }
	User selected autoupdate mode. More...
enum	{   plkrHANDHELD_TARGET_STORAGE_MODE_RAM = 0,   plkrHANDHELD_TARGET_STORAGE_MODE_SD_CARD,   plkrHANDHELD_TARGET_STORAGE_MODE_MEMORY_STICK }
	handheld_dest_type values for handheld_target_storage_mode More...
enum	{   plkrPROMPT_IF_FILE_NOT_FOUND,   plkrCREATE_IF_FILE_NOT_FOUND,   plkrERROR_IF_FILE_NOT_FOUND }
	Behaviour to carry out when user tries to open a file that doesn't exist. More...
enum	{   plkrWINDOW_PLACEMENT_STYLE_CENTER_ON_SCREEN = 0,   plkrWINDOW_PLACEMENT_STYLE_CENTER_ON_PARENT,   plkrWINDOW_PLACEMENT_STYLE_LAST_LOCATION }
	The window popup placement behaviour. More...
enum	{   plkrSTARTUP_TIPS_STYLE_BASIC = 0,   plkrSTARTUP_TIPS_STYLE_ADVANCED,   plkrSTARTUP_TIPS_STYLE_RUBBERCHICKEN }
	Startup tip if not using the configuration value. More...

---

Detailed Description

These defines can be found in plucker_defines.h .

---

Define Documentation

#define plkrAUTOUPDATE_DEFAULT_DEFERRED_LOWER_TIME_LIMIT   "19:00:00"

Default value for the lower autoupdate limit,. This default is shared across the preferences_dialog and the main_listctrl. Format must match the plkrTIME_FORMAT .

#define plkrAUTOUPDATE_DEFAULT_DEFERRED_UPPER_TIME_LIMIT   "23:00:00"

Default value for the upper autoupdate limit,. This default is shared across the preferences_dialog and the main_listctrl. Format must match the plkrTIME_FORMAT .

#define plkrDATE_FORMAT   "%Y-%m-%d"

The format of the component time. Example: 08:15:30. Obviously matching the format of the plkrDATE_TIME_FORMAT .

#define plkrDATE_TIME_FORMAT   "%Y-%m-%dT%H:%M:%S"

Date format to use. Example: 1994-11-05T08:15:30. This is the date format that is recommended by the W3C ( www.w3c.org ). This is the string that is read and written to the configuration file. The format is strict. Note that is a capital Y for 4 digit date (lowercase is 2 digit).

#define plkrDEFAULT_TEXTCTRL_FONT_POINTSIZE   10

The default size of a textctrl font if making a custom font. The GTK one has to be bigger than MSW, else unreadable. Used for example in the editor_dialog.

#define plkrEOL_CHARACTER   "\r\n"

EOL (End Of Line) character used on the OS. Used for example in copying some items to clipboard.

#define plkrFILE_FRIENDLY_DATETIME_STAMP   "plkrFILE_FRIENDLY_DATETIME_STAMP"

A placeholder in a string that gets replaced with a file-friendly datetimestap. For example in the process_progress_listbox.

#define plkrFIXED_PERCENTAGE_GAUGE_RANGE   1000

A fiexed range value for gauges. Prevents flicker if need to change both range/value. By using a fixed range size, then calculating a percentage of it for the value, can stop the flicker of changing both range and value if they keep changing (as is the case in the progress_dialog ).

#define plkrIMAGES_ALWAYS_LINK   1000000L

Image handling alt_maxwidth/alt_maxheight. Tells to always link to the full-size one. The L is required at end to let the wxConfig::Read() and Write() know it is a long property.

#define plkrIMAGES_DEFAULT_MAXHEIGHT   250L

Image handling: default maxheight before an image is thumbnailed. The L is required at end to let the wxConfig::Read() and Write() know it is a long property.

#define plkrIMAGES_DEFAULT_MAXWIDTH   150L

Image handling: default maxwidth before an image is thumbnailed. The L is required at end to let the wxConfig::Read() and Write() know it is a long property.

#define plkrIMAGES_ONLY_THUMBNAIL   0L

Image handling alt_maxwidth/alt_maxheight. Tells to only make a thumbnail, never link. The L is required at end to let the wxConfig::Read() and Write() know it is a long property.

#define plkrINFINITE_STATUS_LINE_LENGTH_LENGTH   1000000L

A high value for the status_line_length key. If equal to this value, unchecks control. The L is required at end to let the wxConfig::Read() and Write() know it is a long property.

#define plkrLISTCTRL_EXTRA_WIDTH_PADDING   9

Number of pixels extra to leave besides the scrollbar width. The extra pixels are used when sizing columns to fill the whole width of the listctrl. Note in GTK on the showcase wherer there is a boatload of hidden columns, there is a small horizontal scrollbar. Todo: Based on number of columns?

#define plkrMAXIMUM_BASE_SECTION_LENGTH   25

Length of a section name in characters before appending a unique number. The number is appended to make it unique if the base name already exists. For example if 'UnnamedChannel' already exists then the new one will be UnnamedChannel1. This sets the length that the 'UnnamedChannel' part can be, before it is truncated, and a number appended. The length is such that it can have very large numbers before exceeding 31 characters (a MacOS concern)

#define plkrMAXIMUM_CHANNEL_NAME_LENGTH   26

Maximum length of a channel name in characters. PalmOS can only allow a database name of 31 characters, otherwise it won't HotSync. The maximum number of characters for a doc_name key entry is therefore 31 characters. However, need to leave 5 characters to leave room for Plkr- in metarecord, so can be kept unique. So max is actually 26.

#define plkrMINIMUM_WIZARD_HEIGHT   250

Minimum height in pixels of a wizard 'content' area. This height does not include the bottom Next/Prev buttons, etc). If the side bitmap exceeds this value, it will be set to the bitmap height. Used in plucker_wizard_base class.

#define plkrMINIMUM_WIZARD_WIDTH   320

Minimum width in pixels of a wizard 'content' area. This width does not including the side bitmap, or frame padding, etc. * Used in plucker_wizard_base class.

#define plkrOS_DIR_SEPARATOR   '\\'

The separator used for multiple directories in a key. The separator is OS specific, since have to choose a character that cannot possibly be in a path on that OS. GTK uses a forward slash, Mac uses a colon, and MSW uses a backslash.

#define plkrOS_FILE_ARRAY_SEPARATOR   ';'

The separator used for multiple files in a key. The separator is OS specific, since have to choose a character that cannot possibly be in a filename on that OS. GTK uses ':'. All others use ';'.

#define plkrPLUCKER_DESKTOP_VERSION_STRING   "1.2.0.8"

Version of the application. The version string, currently written to the config file, so can tell if upgraded. Also showed in the about screen. Rebuild configuration class and main_frame class for it to update. First three digits are the Plucker version, last one is any Plucker Desktop updates.

#define plkrPRETTY_COMPACT_DATE_TIME_FORMAT   "%b %d %H:%M"

A prettier version of DateTime, used only for display only. This is display and display alone, not i/o to configuration file. Example usage: in the main_listctrl "Due" column.

#define plkrSHELL_COMMAND_REPLACEMENT_FILENAME   "plkrFILE"

A placeholder in a user-entered command string that gets replaced with the filename. For example in the open external editor command, if user entered "vim plkrFILE -s" into the edit box and his file start page is somefile.html Plucker Desktop will execute "vim somefile.html -s". If not included in the command string, it will be appended automatically at the end.

#define plkrSTANDARD_SIZER_PADDING   5

Normal number of pixels padding a control inside a sizer, in the xrc resources. Used in the progress_dialog for example.

#define plkrTIME_FORMAT   "%H:%M:%S"

The format of the component time. Example: 1994-11-05. Obviously matching the format of the plkrDATE_TIME_FORMAT .

#define plkrUNNAMED_CHANNEL_NAME   _( "Unnamed channel" )

Default name of channels that don't have a name yet. Todo: Why is this one inside a translation string and all the others aren't? It was probably so that the gettext translator would catch it?

---

Enumeration Type Documentation

anonymous enum

User selected autoupdate mode. The autoupdate mode as selected in the preferences_dialog Autoupdate tab. Enumeration values: plkrAUTOUPDATE_MODE_NEVER  Never autoupdate. plkrAUTOUPDATE_MODE_IMMEDIATELY  Autoupdate as soon as a channel becomes due. plkrAUTOUPDATE_MODE_DEFERRED  Autoupdate if the current time is in the window of allowed times to autoupdate. plkrAUTOUPDATE_MODE_ON_SYNC  Autoupdate when user hits the HotSync button.

anonymous enum

handheld_dest_type values for handheld_target_storage_mode Used when deciding what to do to send to card/RAM when installing. Enumeration values: plkrHANDHELD_TARGET_STORAGE_MODE_RAM  Never autoupdate. plkrHANDHELD_TARGET_STORAGE_MODE_SD_CARD  Autoupdate as soon as a channel becomes due. plkrHANDHELD_TARGET_STORAGE_MODE_MEMORY_STICK  Autoupdate when user hits the HotSync button.

anonymous enum

Behaviour to carry out when user tries to open a file that doesn't exist. Enumeration values: plkrPROMPT_IF_FILE_NOT_FOUND  Show a message dialog asking if they want to create the file. plkrCREATE_IF_FILE_NOT_FOUND  Automatically create the file. plkrERROR_IF_FILE_NOT_FOUND  Show an error message dialog.

anonymous enum

The window popup placement behaviour. Enumeration values: plkrWINDOW_PLACEMENT_STYLE_CENTER_ON_SCREEN  Center new dialog on the screen. plkrWINDOW_PLACEMENT_STYLE_CENTER_ON_PARENT  Center new dialog on the parent dialog. plkrWINDOW_PLACEMENT_STYLE_LAST_LOCATION  Center new dialog on the last remembered location.

anonymous enum

Startup tip if not using the configuration value. For example, in the menu, when choose Help > Show tip, and picking out one. Enumeration values: plkrSTARTUP_TIPS_STYLE_BASIC  A basic Plucker tip. plkrSTARTUP_TIPS_STYLE_ADVANCED  An advanced Plucker tip. plkrSTARTUP_TIPS_STYLE_RUBBERCHICKEN  An iota of rubber chicken trivia.