diff options
| author | Glenn Morris | 2010-10-24 15:45:10 -0700 |
|---|---|---|
| committer | Glenn Morris | 2010-10-24 15:45:10 -0700 |
| commit | 7c051dd87f3bf202cb80f91bb3dab6465e368635 (patch) | |
| tree | e490140208d4b21459743f13cdb3d441989feefe /src/w32fns.c | |
| parent | 9f534a47e3343718b2164497210fe43c2d4f0fa6 (diff) | |
| download | emacs-7c051dd87f3bf202cb80f91bb3dab6465e368635.tar.gz emacs-7c051dd87f3bf202cb80f91bb3dab6465e368635.zip | |
Sync docs of some W32 and X C functions.
* src/w32fns.c (Fx_synchronize, Fx_change_window_property)
(Fx_window_property, Fx_file_dialog):
* src/xfns.c (Fx_synchronize, Fx_change_window_property)
(Fx_window_property, Fx_file_dialog): Sync docs between w32 and X.
Diffstat (limited to 'src/w32fns.c')
| -rw-r--r-- | src/w32fns.c | 62 |
1 files changed, 43 insertions, 19 deletions
diff --git a/src/w32fns.c b/src/w32fns.c index 808503547f1..1612182c660 100644 --- a/src/w32fns.c +++ b/src/w32fns.c | |||
| @@ -1,7 +1,8 @@ | |||
| 1 | /* Graphical user interface functions for the Microsoft W32 API. | 1 | /* Graphical user interface functions for the Microsoft W32 API. |
| 2 | Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, | 2 | |
| 3 | 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 | 3 | Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
| 4 | Free Software Foundation, Inc. | 4 | 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
| 5 | Free Software Foundation, Inc. | ||
| 5 | 6 | ||
| 6 | This file is part of GNU Emacs. | 7 | This file is part of GNU Emacs. |
| 7 | 8 | ||
| @@ -4974,7 +4975,17 @@ DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0, | |||
| 4974 | } | 4975 | } |
| 4975 | 4976 | ||
| 4976 | DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0, | 4977 | DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0, |
| 4977 | doc: /* This is a noop on W32 systems. */) | 4978 | doc: /* If ON is non-nil, report X errors as soon as the erring request is made. |
| 4979 | This function only has an effect on X Windows. With MS Windows, it is | ||
| 4980 | defined but does nothing. | ||
| 4981 | |||
| 4982 | If ON is nil, allow buffering of requests. | ||
| 4983 | Turning on synchronization prohibits the Xlib routines from buffering | ||
| 4984 | requests and seriously degrades performance, but makes debugging much | ||
| 4985 | easier. | ||
| 4986 | The optional second argument TERMINAL specifies which display to act on. | ||
| 4987 | TERMINAL should be a terminal object, a frame or a display name (a string). | ||
| 4988 | If TERMINAL is omitted or nil, that stands for the selected frame's display. */) | ||
| 4978 | (Lisp_Object on, Lisp_Object display) | 4989 | (Lisp_Object on, Lisp_Object display) |
| 4979 | { | 4990 | { |
| 4980 | return Qnil; | 4991 | return Qnil; |
| @@ -4989,11 +5000,12 @@ DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0, | |||
| 4989 | DEFUN ("x-change-window-property", Fx_change_window_property, | 5000 | DEFUN ("x-change-window-property", Fx_change_window_property, |
| 4990 | Sx_change_window_property, 2, 6, 0, | 5001 | Sx_change_window_property, 2, 6, 0, |
| 4991 | doc: /* Change window property PROP to VALUE on the X window of FRAME. | 5002 | doc: /* Change window property PROP to VALUE on the X window of FRAME. |
| 4992 | VALUE may be a string or a list of conses, numbers and/or strings. | 5003 | PROP must be a string. VALUE may be a string or a list of conses, |
| 4993 | If an element in the list is a string, it is converted to | 5004 | numbers and/or strings. If an element in the list is a string, it is |
| 4994 | an Atom and the value of the Atom is used. If an element is a cons, | 5005 | converted to an atom and the value of the Atom is used. If an element |
| 4995 | it is converted to a 32 bit number where the car is the 16 top bits and the | 5006 | is a cons, it is converted to a 32 bit number where the car is the 16 |
| 4996 | cdr is the lower 16 bits. | 5007 | top bits and the cdr is the lower 16 bits. |
| 5008 | |||
| 4997 | FRAME nil or omitted means use the selected frame. | 5009 | FRAME nil or omitted means use the selected frame. |
| 4998 | If TYPE is given and non-nil, it is the name of the type of VALUE. | 5010 | If TYPE is given and non-nil, it is the name of the type of VALUE. |
| 4999 | If TYPE is not given or nil, the type is STRING. | 5011 | If TYPE is not given or nil, the type is STRING. |
| @@ -5001,9 +5013,7 @@ FORMAT gives the size in bits of each element if VALUE is a list. | |||
| 5001 | It must be one of 8, 16 or 32. | 5013 | It must be one of 8, 16 or 32. |
| 5002 | If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8. | 5014 | If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8. |
| 5003 | If OUTER_P is non-nil, the property is changed for the outer X window of | 5015 | If OUTER_P is non-nil, the property is changed for the outer X window of |
| 5004 | FRAME. Default is to change on the edit X window. | 5016 | FRAME. Default is to change on the edit X window. */) |
| 5005 | |||
| 5006 | Value is VALUE. */) | ||
| 5007 | (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p) | 5017 | (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p) |
| 5008 | { | 5018 | { |
| 5009 | #if 0 /* TODO : port window properties to W32 */ | 5019 | #if 0 /* TODO : port window properties to W32 */ |
| @@ -5057,9 +5067,20 @@ FRAME nil or omitted means use the selected frame. Value is PROP. */) | |||
| 5057 | DEFUN ("x-window-property", Fx_window_property, Sx_window_property, | 5067 | DEFUN ("x-window-property", Fx_window_property, Sx_window_property, |
| 5058 | 1, 2, 0, | 5068 | 1, 2, 0, |
| 5059 | doc: /* Value is the value of window property PROP on FRAME. | 5069 | doc: /* Value is the value of window property PROP on FRAME. |
| 5060 | If FRAME is nil or omitted, use the selected frame. Value is nil | 5070 | If FRAME is nil or omitted, use the selected frame. |
| 5061 | if FRAME hasn't a property with name PROP or if PROP has no string | 5071 | |
| 5062 | value. */) | 5072 | On MS Windows, this function only accepts the PROP and FRAME arguments. |
| 5073 | |||
| 5074 | On X Windows, the following optional arguments are also accepted: | ||
| 5075 | If TYPE is nil or omitted, get the property as a string. | ||
| 5076 | Otherwise TYPE is the name of the atom that denotes the type expected. | ||
| 5077 | If SOURCE is non-nil, get the property on that window instead of from | ||
| 5078 | FRAME. The number 0 denotes the root window. | ||
| 5079 | If DELETE_P is non-nil, delete the property after retreiving it. | ||
| 5080 | If VECTOR_RET_P is non-nil, don't return a string but a vector of values. | ||
| 5081 | |||
| 5082 | Value is nil if FRAME hasn't a property with name PROP or if PROP has | ||
| 5083 | no value of TYPE (always string in the MS Windows case). */) | ||
| 5063 | (Lisp_Object prop, Lisp_Object frame) | 5084 | (Lisp_Object prop, Lisp_Object frame) |
| 5064 | { | 5085 | { |
| 5065 | #if 0 /* TODO : port window properties to W32 */ | 5086 | #if 0 /* TODO : port window properties to W32 */ |
| @@ -5948,10 +5969,13 @@ typedef struct | |||
| 5948 | 5969 | ||
| 5949 | DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0, | 5970 | DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0, |
| 5950 | doc: /* Read file name, prompting with PROMPT in directory DIR. | 5971 | doc: /* Read file name, prompting with PROMPT in directory DIR. |
| 5951 | Use a file selection dialog. | 5972 | Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file |
| 5952 | Select DEFAULT-FILENAME in the dialog's file selection box, if | 5973 | selection box, if specified. If MUSTMATCH is non-nil, the returned file |
| 5953 | specified. Ensure that file exists if MUSTMATCH is non-nil. | 5974 | or directory must exist. |
| 5954 | If ONLY-DIR-P is non-nil, the user can only select directories. */) | 5975 | |
| 5976 | This function is only defined on MS Windows, and X Windows with the | ||
| 5977 | Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored. | ||
| 5978 | Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */) | ||
| 5955 | (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p) | 5979 | (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p) |
| 5956 | { | 5980 | { |
| 5957 | struct frame *f = SELECTED_FRAME (); | 5981 | struct frame *f = SELECTED_FRAME (); |