|
virtual void | Show ()=0 |
| Show the Window. More...
|
|
virtual void | ShowAsBrowserModalDialog (CefRefPtr< CefBrowserView > browser_view)=0 |
| Show the Window as a browser modal dialog relative to |browser_view|. More...
|
|
virtual void | Hide ()=0 |
| Hide the Window. More...
|
|
virtual void | CenterWindow (const CefSize &size)=0 |
| Sizes the Window to |size| and centers it in the current display. More...
|
|
virtual void | Close ()=0 |
| Close the Window. More...
|
|
virtual bool | IsClosed ()=0 |
| Returns true if the Window has been closed. More...
|
|
virtual void | Activate ()=0 |
| Activate the Window, assuming it already exists and is visible. More...
|
|
virtual void | Deactivate ()=0 |
| Deactivate the Window, making the next Window in the Z order the active Window. More...
|
|
virtual bool | IsActive ()=0 |
| Returns whether the Window is the currently active Window. More...
|
|
virtual void | BringToTop ()=0 |
| Bring this Window to the top of other Windows in the Windowing system. More...
|
|
virtual void | SetAlwaysOnTop (bool on_top)=0 |
| Set the Window to be on top of other Windows in the Windowing system. More...
|
|
virtual bool | IsAlwaysOnTop ()=0 |
| Returns whether the Window has been set to be on top of other Windows in the Windowing system. More...
|
|
virtual void | Maximize ()=0 |
| Maximize the Window. More...
|
|
virtual void | Minimize ()=0 |
| Minimize the Window. More...
|
|
virtual void | Restore ()=0 |
| Restore the Window. More...
|
|
virtual void | SetFullscreen (bool fullscreen)=0 |
| Set fullscreen Window state. More...
|
|
virtual bool | IsMaximized ()=0 |
| Returns true if the Window is maximized. More...
|
|
virtual bool | IsMinimized ()=0 |
| Returns true if the Window is minimized. More...
|
|
virtual bool | IsFullscreen ()=0 |
| Returns true if the Window is fullscreen. More...
|
|
virtual CefRefPtr< CefView > | GetFocusedView ()=0 |
| Returns the View that currently has focus in this Window, or nullptr if no View currently has focus. More...
|
|
virtual void | SetTitle (const CefString &title)=0 |
| Set the Window title. More...
|
|
virtual CefString | GetTitle ()=0 |
| Get the Window title. More...
|
|
virtual void | SetWindowIcon (CefRefPtr< CefImage > image)=0 |
| Set the Window icon. More...
|
|
virtual CefRefPtr< CefImage > | GetWindowIcon ()=0 |
| Get the Window icon. More...
|
|
virtual void | SetWindowAppIcon (CefRefPtr< CefImage > image)=0 |
| Set the Window App icon. More...
|
|
virtual CefRefPtr< CefImage > | GetWindowAppIcon ()=0 |
| Get the Window App icon. More...
|
|
virtual CefRefPtr< CefOverlayController > | AddOverlayView (CefRefPtr< CefView > view, cef_docking_mode_t docking_mode, bool can_activate)=0 |
| Add a View that will be overlayed on the Window contents with absolute positioning and high z-order. More...
|
|
virtual void | ShowMenu (CefRefPtr< CefMenuModel > menu_model, const CefPoint &screen_point, cef_menu_anchor_position_t anchor_position)=0 |
| Show a menu with contents |menu_model|. More...
|
|
virtual void | CancelMenu ()=0 |
| Cancel the menu that is currently showing, if any. More...
|
|
virtual CefRefPtr< CefDisplay > | GetDisplay ()=0 |
| Returns the Display that most closely intersects the bounds of this Window. More...
|
|
virtual CefRect | GetClientAreaBoundsInScreen ()=0 |
| Returns the bounds (size and position) of this Window's client area. More...
|
|
virtual void | SetDraggableRegions (const std::vector< CefDraggableRegion > ®ions)=0 |
| Set the regions where mouse events will be intercepted by this Window to support drag operations. More...
|
|
virtual CefWindowHandle | GetWindowHandle ()=0 |
| Retrieve the platform window handle for this Window. More...
|
|
virtual void | SendKeyPress (int key_code, uint32_t event_flags)=0 |
| Simulate a key press. More...
|
|
virtual void | SendMouseMove (int screen_x, int screen_y)=0 |
| Simulate a mouse move. More...
|
|
virtual void | SendMouseEvents (cef_mouse_button_type_t button, bool mouse_down, bool mouse_up)=0 |
| Simulate mouse down and/or mouse up events. More...
|
|
virtual void | SetAccelerator (int command_id, int key_code, bool shift_pressed, bool ctrl_pressed, bool alt_pressed, bool high_priority)=0 |
| Set the keyboard accelerator for the specified |command_id|. More...
|
|
virtual void | RemoveAccelerator (int command_id)=0 |
| Remove the keyboard accelerator for the specified |command_id|. More...
|
|
virtual void | RemoveAllAccelerators ()=0 |
| Remove all keyboard accelerators. More...
|
|
virtual void | SetThemeColor (int color_id, cef_color_t color)=0 |
| Override a standard theme color or add a custom color associated with |color_id|. More...
|
|
virtual void | ThemeChanged ()=0 |
| Trigger CefViewDelegate::OnThemeChanged callbacks for each View in this Window's component hierarchy. More...
|
|
virtual cef_runtime_style_t | GetRuntimeStyle ()=0 |
| Returns the runtime style for this Window (ALLOY or CHROME). More...
|
|
virtual CefRefPtr< CefWindow > | AsWindow ()=0 |
| Returns this Panel as a Window or NULL if this is not a Window. More...
|
|
virtual CefRefPtr< CefFillLayout > | SetToFillLayout ()=0 |
| Set this Panel's Layout to FillLayout and return the FillLayout object. More...
|
|
virtual CefRefPtr< CefBoxLayout > | SetToBoxLayout (const CefBoxLayoutSettings &settings)=0 |
| Set this Panel's Layout to BoxLayout and return the BoxLayout object. More...
|
|
virtual CefRefPtr< CefLayout > | GetLayout ()=0 |
| Get the Layout. More...
|
|
virtual void | Layout ()=0 |
| Lay out the child Views (set their bounds based on sizing heuristics specific to the current Layout). More...
|
|
virtual void | AddChildView (CefRefPtr< CefView > view)=0 |
| Add a child View. More...
|
|
virtual void | AddChildViewAt (CefRefPtr< CefView > view, int index)=0 |
| Add a child View at the specified |index|. More...
|
|
virtual void | ReorderChildView (CefRefPtr< CefView > view, int index)=0 |
| Move the child View to the specified |index|. More...
|
|
virtual void | RemoveChildView (CefRefPtr< CefView > view)=0 |
| Remove a child View. More...
|
|
virtual void | RemoveAllChildViews ()=0 |
| Remove all child Views. More...
|
|
virtual size_t | GetChildViewCount ()=0 |
| Returns the number of child Views. More...
|
|
virtual CefRefPtr< CefView > | GetChildViewAt (int index)=0 |
| Returns the child View at the specified |index|. More...
|
|
virtual CefRefPtr< CefBrowserView > | AsBrowserView ()=0 |
| Returns this View as a BrowserView or NULL if this is not a BrowserView. More...
|
|
virtual CefRefPtr< CefButton > | AsButton ()=0 |
| Returns this View as a Button or NULL if this is not a Button. More...
|
|
virtual CefRefPtr< CefPanel > | AsPanel ()=0 |
| Returns this View as a Panel or NULL if this is not a Panel. More...
|
|
virtual CefRefPtr< CefScrollView > | AsScrollView ()=0 |
| Returns this View as a ScrollView or NULL if this is not a ScrollView. More...
|
|
virtual CefRefPtr< CefTextfield > | AsTextfield ()=0 |
| Returns this View as a Textfield or NULL if this is not a Textfield. More...
|
|
virtual CefString | GetTypeString ()=0 |
| Returns the type of this View as a string. More...
|
|
virtual CefString | ToString (bool include_children)=0 |
| Returns a string representation of this View which includes the type and various type-specific identifying attributes. More...
|
|
virtual bool | IsValid ()=0 |
| Returns true if this View is valid. More...
|
|
virtual bool | IsAttached ()=0 |
| Returns true if this View is currently attached to another View. More...
|
|
virtual bool | IsSame (CefRefPtr< CefView > that)=0 |
| Returns true if this View is the same as |that| View. More...
|
|
virtual CefRefPtr< CefViewDelegate > | GetDelegate ()=0 |
| Returns the delegate associated with this View, if any. More...
|
|
virtual CefRefPtr< CefWindow > | GetWindow ()=0 |
| Returns the top-level Window hosting this View, if any. More...
|
|
virtual int | GetID ()=0 |
| Returns the ID for this View. More...
|
|
virtual void | SetID (int id)=0 |
| Sets the ID for this View. More...
|
|
virtual int | GetGroupID ()=0 |
| Returns the group id of this View, or -1 if not set. More...
|
|
virtual void | SetGroupID (int group_id)=0 |
| A group id is used to tag Views which are part of the same logical group. More...
|
|
virtual CefRefPtr< CefView > | GetParentView ()=0 |
| Returns the View that contains this View, if any. More...
|
|
virtual CefRefPtr< CefView > | GetViewForID (int id)=0 |
| Recursively descends the view tree starting at this View, and returns the first child that it encounters with the given ID. More...
|
|
virtual void | SetBounds (const CefRect &bounds)=0 |
| Sets the bounds (size and position) of this View. More...
|
|
virtual CefRect | GetBounds ()=0 |
| Returns the bounds (size and position) of this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
|
|
virtual CefRect | GetBoundsInScreen ()=0 |
| Returns the bounds (size and position) of this View in DIP screen coordinates. More...
|
|
virtual void | SetSize (const CefSize &size)=0 |
| Sets the size of this View without changing the position. More...
|
|
virtual CefSize | GetSize ()=0 |
| Returns the size of this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
|
|
virtual void | SetPosition (const CefPoint &position)=0 |
| Sets the position of this View without changing the size. More...
|
|
virtual CefPoint | GetPosition ()=0 |
| Returns the position of this View. More...
|
|
virtual void | SetInsets (const CefInsets &insets)=0 |
| Sets the insets for this View. More...
|
|
virtual CefInsets | GetInsets ()=0 |
| Returns the insets for this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
|
|
virtual CefSize | GetPreferredSize ()=0 |
| Returns the size this View would like to be if enough space is available. More...
|
|
virtual void | SizeToPreferredSize ()=0 |
| Size this View to its preferred size. More...
|
|
virtual CefSize | GetMinimumSize ()=0 |
| Returns the minimum size for this View. More...
|
|
virtual CefSize | GetMaximumSize ()=0 |
| Returns the maximum size for this View. More...
|
|
virtual int | GetHeightForWidth (int width)=0 |
| Returns the height necessary to display this View with the provided width. More...
|
|
virtual void | InvalidateLayout ()=0 |
| Indicate that this View and all parent Views require a re-layout. More...
|
|
virtual void | SetVisible (bool visible)=0 |
| Sets whether this View is visible. More...
|
|
virtual bool | IsVisible ()=0 |
| Returns whether this View is visible. More...
|
|
virtual bool | IsDrawn ()=0 |
| Returns whether this View is visible and drawn in a Window. More...
|
|
virtual void | SetEnabled (bool enabled)=0 |
| Set whether this View is enabled. More...
|
|
virtual bool | IsEnabled ()=0 |
| Returns whether this View is enabled. More...
|
|
virtual void | SetFocusable (bool focusable)=0 |
| Sets whether this View is capable of taking focus. More...
|
|
virtual bool | IsFocusable ()=0 |
| Returns true if this View is focusable, enabled and drawn. More...
|
|
virtual bool | IsAccessibilityFocusable ()=0 |
| Return whether this View is focusable when the user requires full keyboard access, even though it may not be normally focusable. More...
|
|
virtual bool | HasFocus ()=0 |
| Returns true if this View has focus in the context of the containing Window. More...
|
|
virtual void | RequestFocus ()=0 |
| Request focus for this View in the context of the containing Window. More...
|
|
virtual void | SetBackgroundColor (cef_color_t color)=0 |
| Sets the background color for this View. More...
|
|
virtual cef_color_t | GetBackgroundColor ()=0 |
| Returns the background color for this View. More...
|
|
virtual cef_color_t | GetThemeColor (int color_id)=0 |
| Returns the current theme color associated with |color_id|, or the placeholder color (red) if unset. More...
|
|
virtual bool | ConvertPointToScreen (CefPoint &point)=0 |
| Convert |point| from this View's coordinate system to DIP screen coordinates. More...
|
|
virtual bool | ConvertPointFromScreen (CefPoint &point)=0 |
| Convert |point| to this View's coordinate system from DIP screen coordinates. More...
|
|
virtual bool | ConvertPointToWindow (CefPoint &point)=0 |
| Convert |point| from this View's coordinate system to that of the Window. More...
|
|
virtual bool | ConvertPointFromWindow (CefPoint &point)=0 |
| Convert |point| to this View's coordinate system from that of the Window. More...
|
|
virtual bool | ConvertPointToView (CefRefPtr< CefView > view, CefPoint &point)=0 |
| Convert |point| from this View's coordinate system to that of |view|. More...
|
|
virtual bool | ConvertPointFromView (CefRefPtr< CefView > view, CefPoint &point)=0 |
| Convert |point| to this View's coordinate system from that |view|. More...
|
|
virtual void | AddRef () const =0 |
| Called to increment the reference count for the object. More...
|
|
virtual bool | Release () const =0 |
| Called to decrement the reference count for the object. More...
|
|
virtual bool | HasOneRef () const =0 |
| Returns true if the reference count is 1. More...
|
|
virtual bool | HasAtLeastOneRef () const =0 |
| Returns true if the reference count is at least 1. More...
|
|
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.