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

68
include/views/cef_window_delegate.h
View File

@ -43,40 +43,40 @@
class CefWindow;
///
// Implement this interface to handle window events. The methods of this class
// will be called on the browser process UI thread unless otherwise indicated.
/// Implement this interface to handle window events. The methods of this class
/// will be called on the browser process UI thread unless otherwise indicated.
///
/*--cef(source=client)--*/
class CefWindowDelegate : public CefPanelDelegate {
public:
///
// Called when |window| is created.
/// Called when |window| is created.
///
/*--cef()--*/
virtual void OnWindowCreated(CefRefPtr<CefWindow> window) {}
///
// Called when |window| is destroyed. Release all references to |window| and
// do not attempt to execute any methods on |window| after this callback
// returns.
/// Called when |window| is destroyed. Release all references to |window| and
/// do not attempt to execute any methods on |window| after this callback
/// returns.
///
/*--cef()--*/
virtual void OnWindowDestroyed(CefRefPtr<CefWindow> window) {}
///
// Called when |window| is activated or deactivated.
/// Called when |window| is activated or deactivated.
///
/*--cef()--*/
virtual void OnWindowActivationChanged(CefRefPtr<CefWindow> window,
bool active) {}
///
// Return the parent for |window| or NULL if the |window| does not have a
// parent. Windows with parents will not get a taskbar button. Set |is_menu|
// to true if |window| will be displayed as a menu, in which case it will not
// be clipped to the parent window bounds. Set |can_activate_menu| to false
// if |is_menu| is true and |window| should not be activated (given keyboard
// focus) when displayed.
/// Return the parent for |window| or NULL if the |window| does not have a
/// parent. Windows with parents will not get a taskbar button. Set |is_menu|
/// to true if |window| will be displayed as a menu, in which case it will not
/// be clipped to the parent window bounds. Set |can_activate_menu| to false
/// if |is_menu| is true and |window| should not be activated (given keyboard
/// focus) when displayed.
///
/*--cef()--*/
virtual CefRefPtr<CefWindow> GetParentWindow(CefRefPtr<CefWindow> window,
@ -86,12 +86,12 @@ class CefWindowDelegate : public CefPanelDelegate {
}
///
// Return the initial bounds for |window| in density independent pixel (DIP)
// coordinates. If this method returns an empty CefRect then
// GetPreferredSize() will be called to retrieve the size, and the window will
// be placed on the screen with origin (0,0). This method can be used in
// combination with CefView::GetBoundsInScreen() to restore the previous
// window bounds.
/// Return the initial bounds for |window| in density independent pixel (DIP)
/// coordinates. If this method returns an empty CefRect then
/// GetPreferredSize() will be called to retrieve the size, and the window
/// will be placed on the screen with origin (0,0). This method can be used in
/// combination with CefView::GetBoundsInScreen() to restore the previous
/// window bounds.
///
/*--cef()--*/
virtual CefRect GetInitialBounds(CefRefPtr<CefWindow> window) {
@ -99,7 +99,7 @@ class CefWindowDelegate : public CefPanelDelegate {
}
///
// Return the initial show state for |window|.
/// Return the initial show state for |window|.
///
/*--cef(default_retval=CEF_SHOW_STATE_NORMAL)--*/
virtual cef_show_state_t GetInitialShowState(CefRefPtr<CefWindow> window) {
@ -107,42 +107,42 @@ class CefWindowDelegate : public CefPanelDelegate {
}
///
// Return true if |window| should be created without a frame or title bar. The
// window will be resizable if CanResize() returns true. Use
// CefWindow::SetDraggableRegions() to specify draggable regions.
/// Return true if |window| should be created without a frame or title bar.
/// The window will be resizable if CanResize() returns true. Use
/// CefWindow::SetDraggableRegions() to specify draggable regions.
///
/*--cef()--*/
virtual bool IsFrameless(CefRefPtr<CefWindow> window) { return false; }
///
// Return true if |window| can be resized.
/// Return true if |window| can be resized.
///
/*--cef()--*/
virtual bool CanResize(CefRefPtr<CefWindow> window) { return true; }
///
// Return true if |window| can be maximized.
/// Return true if |window| can be maximized.
///
/*--cef()--*/
virtual bool CanMaximize(CefRefPtr<CefWindow> window) { return true; }
///
// Return true if |window| can be minimized.
/// Return true if |window| can be minimized.
///
/*--cef()--*/
virtual bool CanMinimize(CefRefPtr<CefWindow> window) { return true; }
///
// Return true if |window| can be closed. This will be called for user-
// initiated window close actions and when CefWindow::Close() is called.
/// Return true if |window| can be closed. This will be called for user-
/// initiated window close actions and when CefWindow::Close() is called.
///
/*--cef()--*/
virtual bool CanClose(CefRefPtr<CefWindow> window) { return true; }
///
// Called when a keyboard accelerator registered with
// CefWindow::SetAccelerator is triggered. Return true if the accelerator was
// handled or false otherwise.
/// Called when a keyboard accelerator registered with
/// CefWindow::SetAccelerator is triggered. Return true if the accelerator was
/// handled or false otherwise.
///
/*--cef()--*/
virtual bool OnAccelerator(CefRefPtr<CefWindow> window, int command_id) {
@ -150,9 +150,9 @@ class CefWindowDelegate : public CefPanelDelegate {
}
///
// Called after all other controls in the window have had a chance to
// handle the event. |event| contains information about the keyboard event.
// Return true if the keyboard event was handled or false otherwise.
/// Called after all other controls in the window have had a chance to
/// handle the event. |event| contains information about the keyboard event.
/// Return true if the keyboard event was handled or false otherwise.
///
/*--cef()--*/
virtual bool OnKeyEvent(CefRefPtr<CefWindow> window,