/* Copyright 1996 Acorn Computers Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/****************************************************************************
 * This source file was written by Acorn Computers Limited. It is part of   *
 * the RISCOS library for writing applications in C for RISC OS. It may be  *
 * used freely in the creation of programs for Archimedes. It should be     *
 * used with Acorn's C Compiler Release 3 or later.                         *
 *                                                                          *
 ***************************************************************************/

/*
 * Title:   txtopt.h
 * Purpose: setting/reading the name used for setting text editing options
 *
 */

#ifndef __txtopt_h
#define __txtopt_h


/* ----------------------------- txtopt_set_name ---------------------------
 * Description:   Set the name used as a system variable for setting text
 *                editing options
 *
 * Parameters:    char *name -- the name to be prepended to $Options to form
 *                              the system variable name.
 * Returns:       void.
 * Other Info:    If this function is not called before using any of the
 *                txt and txtedit functions, the system variable name
 *                defaults to Edit$Options.
 *                eg. txtopt_set_name("MyEdit") sets the system variable name
 *                to MyEdit$Options
 *
 */

void txtopt_set_name(char *name);


/* ---------------------------- txtopt_get_name ----------------------------
 * Description:   Get a pointer to the name currently prepended to $Options
 *                to form a system variable for use in setting text editing
 *                options.
 *
 * Parameters:    void.
 * Returns:       pointer to name
 * Other Info:    If no name has been set, this will point to "Edit".
 *                eg. assuming option name is currently MyEdit$Options
 *                then txtopt_get_name will return a pointer to the string
 *                "MyEdit".
 *
 */

char *txtopt_get_name(void);

#endif