Remove an incorrect comment and check for 0 being an invalid file
[wine/multimedia.git] / server / user.h
blob84d3d04443a862e929e279029923264768940408
1 /*
2 * Wine server USER definitions
4 * Copyright (C) 2001 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __WINE_SERVER_USER_H
22 #define __WINE_SERVER_USER_H
24 #include "wine/server_protocol.h"
26 struct thread;
27 struct region;
28 struct window;
29 struct msg_queue;
30 struct hook_table;
31 struct window_class;
32 struct atom_table;
33 struct clipboard;
35 enum user_object
37 USER_WINDOW = 1,
38 USER_HOOK
41 #define DESKTOP_ATOM ((atom_t)32769)
43 struct winstation
45 struct object obj; /* object header */
46 unsigned int flags; /* winstation flags */
47 struct list entry; /* entry in global winstation list */
48 struct list desktops; /* list of desktops of this winstation */
49 struct clipboard *clipboard; /* clipboard information */
50 struct atom_table *atom_table; /* global atom table */
53 struct desktop
55 struct object obj; /* object header */
56 unsigned int flags; /* desktop flags */
57 struct winstation *winstation; /* winstation this desktop belongs to */
58 struct list entry; /* entry in winstation list of desktops */
59 struct window *top_window; /* desktop window for this desktop */
60 struct hook_table *global_hooks; /* table of global hooks on this desktop */
63 /* user handles functions */
65 extern user_handle_t alloc_user_handle( void *ptr, enum user_object type );
66 extern void *get_user_object( user_handle_t handle, enum user_object type );
67 extern void *get_user_object_handle( user_handle_t *handle, enum user_object type );
68 extern user_handle_t get_user_full_handle( user_handle_t handle );
69 extern void *free_user_handle( user_handle_t handle );
70 extern void *next_user_handle( user_handle_t *handle, enum user_object type );
72 /* clipboard functions */
74 extern void cleanup_clipboard_thread( struct thread *thread );
76 /* hook functions */
78 extern void remove_thread_hooks( struct thread *thread );
79 extern unsigned int get_active_hooks(void);
81 /* queue functions */
83 extern void free_msg_queue( struct thread *thread );
84 extern struct hook_table *get_queue_hooks( struct thread *thread );
85 extern void set_queue_hooks( struct thread *thread, struct hook_table *hooks );
86 extern void inc_queue_paint_count( struct thread *thread, int incr );
87 extern void queue_cleanup_window( struct thread *thread, user_handle_t win );
88 extern int init_thread_queue( struct thread *thread );
89 extern int attach_thread_input( struct thread *thread_from, struct thread *thread_to );
90 extern void detach_thread_input( struct thread *thread_from );
91 extern void post_message( user_handle_t win, unsigned int message,
92 unsigned int wparam, unsigned int lparam );
93 extern void post_win_event( struct thread *thread, unsigned int event,
94 user_handle_t win, unsigned int object_id,
95 unsigned int child_id, void *proc,
96 const WCHAR *module, size_t module_size,
97 user_handle_t handle );
99 /* region functions */
101 extern struct region *create_empty_region(void);
102 extern struct region *create_region_from_req_data( const void *data, size_t size );
103 extern void free_region( struct region *region );
104 extern void set_region_rect( struct region *region, const rectangle_t *rect );
105 extern rectangle_t *get_region_data( const struct region *region, size_t max_size,
106 size_t *total_size );
107 extern rectangle_t *get_region_data_and_free( struct region *region, size_t max_size,
108 size_t *total_size );
109 extern int is_region_empty( const struct region *region );
110 extern void get_region_extents( const struct region *region, rectangle_t *rect );
111 extern void offset_region( struct region *region, int x, int y );
112 extern struct region *copy_region( struct region *dst, const struct region *src );
113 extern struct region *intersect_region( struct region *dst, const struct region *src1,
114 const struct region *src2 );
115 extern struct region *subtract_region( struct region *dst, const struct region *src1,
116 const struct region *src2 );
117 extern struct region *union_region( struct region *dst, const struct region *src1,
118 const struct region *src2 );
119 extern struct region *xor_region( struct region *dst, const struct region *src1,
120 const struct region *src2 );
121 extern int point_in_region( struct region *region, int x, int y );
122 extern int rect_in_region( struct region *region, const rectangle_t *rect );
124 /* window functions */
126 extern void destroy_window( struct window *win );
127 extern void destroy_thread_windows( struct thread *thread );
128 extern int is_child_window( user_handle_t parent, user_handle_t child );
129 extern int is_top_level_window( user_handle_t window );
130 extern int is_window_visible( user_handle_t window );
131 extern int make_window_active( user_handle_t window );
132 extern struct thread *get_window_thread( user_handle_t handle );
133 extern user_handle_t window_from_point( struct desktop *desktop, int x, int y );
134 extern user_handle_t find_window_to_repaint( user_handle_t parent, struct thread *thread );
135 extern struct window_class *get_window_class( user_handle_t window );
137 /* window class functions */
139 extern void destroy_process_classes( struct process *process );
140 extern struct window_class *grab_class( struct process *process, atom_t atom,
141 void *instance, int *extra_bytes );
142 extern void release_class( struct window_class *class );
143 extern atom_t get_class_atom( struct window_class *class );
144 extern void *get_class_client_ptr( struct window_class *class );
146 /* windows station functions */
148 extern struct winstation *get_process_winstation( struct process *process, unsigned int access );
149 extern struct desktop *get_thread_desktop( struct thread *thread, unsigned int access );
150 extern void connect_process_winstation( struct process *process, const WCHAR *name, size_t len );
151 extern void connect_process_desktop( struct process *process, const WCHAR *name, size_t len );
152 extern void close_thread_desktop( struct thread *thread );
154 #endif /* __WINE_SERVER_USER_H */