external-format-for-saved-files

Generic Function

Package: cg

ToC

DocOverview

CGDoc

RelNotes

FAQ

Index

PermutedIndex

Allegro CL version 9.0
This page is new in 9.0.

external-format-for-saved-files

Arguments: cg-configuration

This configuration option determines the character encoding that will be used by the function save-file for saving the text that's in a text-edit-pane to a file. This applies only on the Windows platform, because GTk always uses the UTF8 format.

This option affects the IDE's source code editor because it calls save-file whenever it saves a file.

This option is generally used only when saving a text-edit-pane's text to file for the first time, rather than when re-saving a file that was loaded and edited. Specifically, when load-file is called to load text into a text-edit-pane, the external format that was used for reading the file is stored as the external-format-for-save property of the text-edit-pane, and save-file will later use that same external format to update the file. The options below will be used only if the external-format-for-save property is nil (either because no file was loaded or because you've set that property back to nil), or if this option value is :ask-always.

Here are the valid values for this option. Some of these are the same as valid stream-external-format values.

:default -- Saves a new file using the external format of the locale with which the Windows operating system is currently booted. This is the default value, and is what was always done in Allegro releases prior to 9.0.
:unicode -- Saves a new file in a little-endian 16-bit Unicode format.
:utf8 -- Saves a new file in UTF8 format. This format is always used on GTk platforms.
:ask-new -- When saving a new file, shows a modal dialog asking which of the above formats to use.
:ask-always -- Always shows a dialog asking which format to use when saving a file, even when updating a file that had been loaded with load-file.

See also automatic-font-changing and excl:*use-unicode-winapi-for-cg*. The configuration option write-bom-to-utf8-files controls whether save-file will write UTF8 byte order marker (BOM) bytes at the beginning of the file, if the file is being saved in UTF8 format.