bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update include/ comments to Doxygen formatting (see issue #3384)

Browse Source 
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
2022-08-31 22:03:04 -04:00
parent 7b352159df
commit d7a153bdd4
235 changed files with 11484 additions and 11274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

198
include/capi/views/cef_window_capi.h
View File

@@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for
// more information.
//
// $hash=1785245d89e84d5a27ce062208bc19a4031ce97f$
// $hash=ba3a92d4e09b2f728b330a822669c64ddff1f9d6$
//
#ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_WINDOW_CAPI_H_
@@ -52,180 +52,180 @@ extern "C" {
#endif
///
// A Window is a top-level Window/widget in the Views hierarchy. By default it
// will have a non-client area with title bar, icon and buttons that supports
// moving and resizing. All size and position values are in density independent
// pixels (DIP) unless otherwise indicated. Methods must be called on the
// browser process UI thread unless otherwise indicated.
/// A Window is a top-level Window/widget in the Views hierarchy. By default it
/// will have a non-client area with title bar, icon and buttons that supports
/// moving and resizing. All size and position values are in density independent
/// pixels (DIP) unless otherwise indicated. Methods must be called on the
/// browser process UI thread unless otherwise indicated.
///
typedef struct _cef_window_t {
///
// Base structure.
/// Base structure.
///
cef_panel_t base;
///
// Show the Window.
/// Show the Window.
///
void(CEF_CALLBACK* show)(struct _cef_window_t* self);
///
// Hide the Window.
/// Hide the Window.
///
void(CEF_CALLBACK* hide)(struct _cef_window_t* self);
///
// Sizes the Window to |size| and centers it in the current display.
/// Sizes the Window to |size| and centers it in the current display.
///
void(CEF_CALLBACK* center_window)(struct _cef_window_t* self,
const cef_size_t* size);
///
// Close the Window.
/// Close the Window.
///
void(CEF_CALLBACK* close)(struct _cef_window_t* self);
///
// Returns true (1) if the Window has been closed.
/// Returns true (1) if the Window has been closed.
///
int(CEF_CALLBACK* is_closed)(struct _cef_window_t* self);
///
// Activate the Window, assuming it already exists and is visible.
/// Activate the Window, assuming it already exists and is visible.
///
void(CEF_CALLBACK* activate)(struct _cef_window_t* self);
///
// Deactivate the Window, making the next Window in the Z order the active
// Window.
/// Deactivate the Window, making the next Window in the Z order the active
/// Window.
///
void(CEF_CALLBACK* deactivate)(struct _cef_window_t* self);
///
// Returns whether the Window is the currently active Window.
/// Returns whether the Window is the currently active Window.
///
int(CEF_CALLBACK* is_active)(struct _cef_window_t* self);
///
// Bring this Window to the top of other Windows in the Windowing system.
/// Bring this Window to the top of other Windows in the Windowing system.
///
void(CEF_CALLBACK* bring_to_top)(struct _cef_window_t* self);
///
// Set the Window to be on top of other Windows in the Windowing system.
/// Set the Window to be on top of other Windows in the Windowing system.
///
void(CEF_CALLBACK* set_always_on_top)(struct _cef_window_t* self, int on_top);
///
// Returns whether the Window has been set to be on top of other Windows in
// the Windowing system.
/// Returns whether the Window has been set to be on top of other Windows in
/// the Windowing system.
///
int(CEF_CALLBACK* is_always_on_top)(struct _cef_window_t* self);
///
// Maximize the Window.
/// Maximize the Window.
///
void(CEF_CALLBACK* maximize)(struct _cef_window_t* self);
///
// Minimize the Window.
/// Minimize the Window.
///
void(CEF_CALLBACK* minimize)(struct _cef_window_t* self);
///
// Restore the Window.
/// Restore the Window.
///
void(CEF_CALLBACK* restore)(struct _cef_window_t* self);
///
// Set fullscreen Window state.
/// Set fullscreen Window state.
///
void(CEF_CALLBACK* set_fullscreen)(struct _cef_window_t* self,
int fullscreen);
///
// Returns true (1) if the Window is maximized.
/// Returns true (1) if the Window is maximized.
///
int(CEF_CALLBACK* is_maximized)(struct _cef_window_t* self);
///
// Returns true (1) if the Window is minimized.
/// Returns true (1) if the Window is minimized.
///
int(CEF_CALLBACK* is_minimized)(struct _cef_window_t* self);
///
// Returns true (1) if the Window is fullscreen.
/// Returns true (1) if the Window is fullscreen.
///
int(CEF_CALLBACK* is_fullscreen)(struct _cef_window_t* self);
///
// Set the Window title.
/// Set the Window title.
///
void(CEF_CALLBACK* set_title)(struct _cef_window_t* self,
const cef_string_t* title);
///
// Get the Window title.
/// Get the Window title.
///
// The resulting string must be freed by calling cef_string_userfree_free().
cef_string_userfree_t(CEF_CALLBACK* get_title)(struct _cef_window_t* self);
///
// Set the Window icon. This should be a 16x16 icon suitable for use in the
// Windows's title bar.
/// Set the Window icon. This should be a 16x16 icon suitable for use in the
/// Windows's title bar.
///
void(CEF_CALLBACK* set_window_icon)(struct _cef_window_t* self,
struct _cef_image_t* image);
///
// Get the Window icon.
/// Get the Window icon.
///
struct _cef_image_t*(CEF_CALLBACK* get_window_icon)(
struct _cef_window_t* self);
///
// Set the Window App icon. This should be a larger icon for use in the host
// environment app switching UI. On Windows, this is the ICON_BIG used in Alt-
// Tab list and Windows taskbar. The Window icon will be used by default if no
// Window App icon is specified.
/// Set the Window App icon. This should be a larger icon for use in the host
/// environment app switching UI. On Windows, this is the ICON_BIG used in
/// Alt-Tab list and Windows taskbar. The Window icon will be used by default
/// if no Window App icon is specified.
///
void(CEF_CALLBACK* set_window_app_icon)(struct _cef_window_t* self,
struct _cef_image_t* image);
///
// Get the Window App icon.
/// Get the Window App icon.
///
struct _cef_image_t*(CEF_CALLBACK* get_window_app_icon)(
struct _cef_window_t* self);
///
// Add a View that will be overlayed on the Window contents with absolute
// positioning and high z-order. Positioning is controlled by |docking_mode|
// as described below. The returned cef_overlay_controller_t object is used to
// control the overlay. Overlays are hidden by default.
//
// With CEF_DOCKING_MODE_CUSTOM:
// 1. The overlay is initially hidden, sized to |view|'s preferred size, and
// positioned in the top-left corner.
// 2. Optionally change the overlay position and/or size by calling
// CefOverlayController methods.
// 3. Call CefOverlayController::SetVisible(true) to show the overlay.
// 4. The overlay will be automatically re-sized if |view|'s layout changes.
// Optionally change the overlay position and/or size when
// OnLayoutChanged is called on the Window's delegate to indicate a
// change in Window bounds.
//
// With other docking modes:
// 1. The overlay is initially hidden, sized to |view|'s preferred size, and
// positioned based on |docking_mode|.
// 2. Call CefOverlayController::SetVisible(true) to show the overlay.
// 3. The overlay will be automatically re-sized if |view|'s layout changes
// and re-positioned as appropriate when the Window resizes.
//
// Overlays created by this function will receive a higher z-order then any
// child Views added previously. It is therefore recommended to call this
// function last after all other child Views have been added so that the
// overlay displays as the top-most child of the Window.
/// Add a View that will be overlayed on the Window contents with absolute
/// positioning and high z-order. Positioning is controlled by |docking_mode|
/// as described below. The returned cef_overlay_controller_t object is used
/// to control the overlay. Overlays are hidden by default.
///
/// With CEF_DOCKING_MODE_CUSTOM:
/// 1. The overlay is initially hidden, sized to |view|'s preferred size,
/// and positioned in the top-left corner.
/// 2. Optionally change the overlay position and/or size by calling
/// CefOverlayController methods.
/// 3. Call CefOverlayController::SetVisible(true) to show the overlay.
/// 4. The overlay will be automatically re-sized if |view|'s layout
/// changes. Optionally change the overlay position and/or size when
/// OnLayoutChanged is called on the Window's delegate to indicate a
/// change in Window bounds.
///
/// With other docking modes:
/// 1. The overlay is initially hidden, sized to |view|'s preferred size,
/// and positioned based on |docking_mode|.
/// 2. Call CefOverlayController::SetVisible(true) to show the overlay.
/// 3. The overlay will be automatically re-sized if |view|'s layout changes
/// and re-positioned as appropriate when the Window resizes.
///
/// Overlays created by this function will receive a higher z-order then any
/// child Views added previously. It is therefore recommended to call this
/// function last after all other child Views have been added so that the
/// overlay displays as the top-most child of the Window.
///
struct _cef_overlay_controller_t*(CEF_CALLBACK* add_overlay_view)(
struct _cef_window_t* self,
@@ -233,9 +233,9 @@ typedef struct _cef_window_t {
cef_docking_mode_t docking_mode);
///
// Show a menu with contents |menu_model|. |screen_point| specifies the menu
// position in screen coordinates. |anchor_position| specifies how the menu
// will be anchored relative to |screen_point|.
/// Show a menu with contents |menu_model|. |screen_point| specifies the menu
/// position in screen coordinates. |anchor_position| specifies how the menu
/// will be anchored relative to |screen_point|.
///
void(CEF_CALLBACK* show_menu)(struct _cef_window_t* self,
struct _cef_menu_model_t* menu_model,
@@ -243,28 +243,28 @@ typedef struct _cef_window_t {
cef_menu_anchor_position_t anchor_position);
///
// Cancel the menu that is currently showing, if any.
/// Cancel the menu that is currently showing, if any.
///
void(CEF_CALLBACK* cancel_menu)(struct _cef_window_t* self);
///
// Returns the Display that most closely intersects the bounds of this Window.
// May return NULL if this Window is not currently displayed.
/// Returns the Display that most closely intersects the bounds of this
/// Window. May return NULL if this Window is not currently displayed.
///
struct _cef_display_t*(CEF_CALLBACK* get_display)(struct _cef_window_t* self);
///
// Returns the bounds (size and position) of this Window's client area.
// Position is in screen coordinates.
/// Returns the bounds (size and position) of this Window's client area.
/// Position is in screen coordinates.
///
cef_rect_t(CEF_CALLBACK* get_client_area_bounds_in_screen)(
struct _cef_window_t* self);
///
// Set the regions where mouse events will be intercepted by this Window to
// support drag operations. Call this function with an NULL vector to clear
// the draggable regions. The draggable region bounds should be in window
// coordinates.
/// Set the regions where mouse events will be intercepted by this Window to
/// support drag operations. Call this function with an NULL vector to clear
/// the draggable regions. The draggable region bounds should be in window
/// coordinates.
///
void(CEF_CALLBACK* set_draggable_regions)(
struct _cef_window_t* self,
@@ -272,39 +272,39 @@ typedef struct _cef_window_t {
cef_draggable_region_t const* regions);
///
// Retrieve the platform window handle for this Window.
/// Retrieve the platform window handle for this Window.
///
cef_window_handle_t(CEF_CALLBACK* get_window_handle)(
struct _cef_window_t* self);
///
// Simulate a key press. |key_code| is the VKEY_* value from Chromium's
// ui/events/keycodes/keyboard_codes.h header (VK_* values on Windows).
// |event_flags| is some combination of EVENTFLAG_SHIFT_DOWN,
// EVENTFLAG_CONTROL_DOWN and/or EVENTFLAG_ALT_DOWN. This function is exposed
// primarily for testing purposes.
/// Simulate a key press. |key_code| is the VKEY_* value from Chromium's
/// ui/events/keycodes/keyboard_codes.h header (VK_* values on Windows).
/// |event_flags| is some combination of EVENTFLAG_SHIFT_DOWN,
/// EVENTFLAG_CONTROL_DOWN and/or EVENTFLAG_ALT_DOWN. This function is exposed
/// primarily for testing purposes.
///
void(CEF_CALLBACK* send_key_press)(struct _cef_window_t* self,
int key_code,
uint32 event_flags);
///
// Simulate a mouse move. The mouse cursor will be moved to the specified
// (screen_x, screen_y) position. This function is exposed primarily for
// testing purposes.
/// Simulate a mouse move. The mouse cursor will be moved to the specified
/// (screen_x, screen_y) position. This function is exposed primarily for
/// testing purposes.
///
void(CEF_CALLBACK* send_mouse_move)(struct _cef_window_t* self,
int screen_x,
int screen_y);
///
// Simulate mouse down and/or mouse up events. |button| is the mouse button
// type. If |mouse_down| is true (1) a mouse down event will be sent. If
// |mouse_up| is true (1) a mouse up event will be sent. If both are true (1)
// a mouse down event will be sent followed by a mouse up event (equivalent to
// clicking the mouse button). The events will be sent using the current
// cursor position so make sure to call send_mouse_move() first to position
// the mouse. This function is exposed primarily for testing purposes.
/// Simulate mouse down and/or mouse up events. |button| is the mouse button
/// type. If |mouse_down| is true (1) a mouse down event will be sent. If
/// |mouse_up| is true (1) a mouse up event will be sent. If both are true (1)
/// a mouse down event will be sent followed by a mouse up event (equivalent
/// to clicking the mouse button). The events will be sent using the current
/// cursor position so make sure to call send_mouse_move() first to position
/// the mouse. This function is exposed primarily for testing purposes.
///
void(CEF_CALLBACK* send_mouse_events)(struct _cef_window_t* self,
cef_mouse_button_type_t button,
@@ -312,10 +312,10 @@ typedef struct _cef_window_t {
int mouse_up);
///
// Set the keyboard accelerator for the specified |command_id|. |key_code| can
// be any virtual key or character value. cef_window_delegate_t::OnAccelerator
// will be called if the keyboard combination is triggered while this window
// has focus.
/// Set the keyboard accelerator for the specified |command_id|. |key_code|
/// can be any virtual key or character value.
/// cef_window_delegate_t::OnAccelerator will be called if the keyboard
/// combination is triggered while this window has focus.
///
void(CEF_CALLBACK* set_accelerator)(struct _cef_window_t* self,
int command_id,
@@ -325,19 +325,19 @@ typedef struct _cef_window_t {
int alt_pressed);
///
// Remove the keyboard accelerator for the specified |command_id|.
/// Remove the keyboard accelerator for the specified |command_id|.
///
void(CEF_CALLBACK* remove_accelerator)(struct _cef_window_t* self,
int command_id);
///
// Remove all keyboard accelerators.
/// Remove all keyboard accelerators.
///
void(CEF_CALLBACK* remove_all_accelerators)(struct _cef_window_t* self);
} cef_window_t;
///
// Create a new Window.
/// Create a new Window.
///
CEF_EXPORT cef_window_t* cef_window_create_top_level(
struct _cef_window_delegate_t* delegate);