neoGFX
Cross-platform C++ app/game engine
Loading...
Searching...
No Matches
neogfx::i_title_bar Class Referenceabstract

#include <i_title_bar.hpp>

Inheritance diagram for neogfx::i_title_bar:
neogfx::i_widget neogfx::i_layout_item neogfx::i_keyboard_handler neogfx::i_mouse_handler neogfx::i_skinnable_item neolib::i_reference_counted neogfx::i_property_owner neogfx::i_anchorable neogfx::i_object neolib::i_object neolib::i_lifetime

Classes

struct  unsupported_operation
 

Public Types

typedef i_title_bar abstract_type
 
- Public Types inherited from neogfx::i_layout_item
typedef i_layout_item abstract_type
 
- Public Types inherited from neogfx::i_anchorable
typedef i_anchorable abstract_type
 
typedef neolib::i_map< i_string, i_anchor * > anchor_map_type
 

Public Member Functions

virtual ~i_title_bar ()=default
 
virtual void set_icon (i_texture const &aIcon)=0
 
virtual i_image_widget const & icon_widget () const =0
 
virtual i_image_widgeticon_widget ()=0
 
virtual i_string const & title () const =0
 
virtual void set_title (i_string const &aTitle)=0
 
virtual i_text_widget const & title_widget () const =0
 
virtual i_text_widgettitle_widget ()=0
 
- Public Member Functions inherited from neogfx::i_widget
 declare_event (device_metrics_updated, const i_widget &) declare_event(child_added
 
i_widgetdeclare_event (child_removed, i_widget &) declare_event(visibility_changed) declare_event(position_changed) declare_event(parent_position_changed) declare_event(size_changed) declare_event(layout_completed) declare_event(painting
 
i_widget i_graphics_contextdeclare_event (painting_children, i_graphics_context &) declare_event(painted
 
i_widget i_graphics_context i_graphics_contextdeclare_event (mouse_event, const neogfx::mouse_event &) declare_event(non_client_mouse_event
 
i_widget i_graphics_context i_graphics_context const neogfx::non_client_mouse_eventdeclare_event (query_mouse_cursor, neogfx::mouse_cursor &) declare_event(keyboard_event
 
virtual ~i_widget ()=default
 
virtual bool is_singular () const =0
 
virtual void set_singular (bool aSingular)=0
 
virtual bool is_root () const =0
 
virtual bool has_root () const =0
 
virtual const i_windowroot () const =0
 
virtual i_windowroot ()=0
 
virtual void set_root (i_window &aRoot)=0
 
virtual bool has_surface () const =0
 
virtual bool is_surface () const =0
 
virtual const i_surfacesurface () const =0
 
virtual i_surfacesurface ()=0
 
virtual const i_surfacereal_surface () const =0
 
virtual i_surfacereal_surface ()=0
 
virtual bool has_parent () const =0
 
virtual const i_widgetparent () const =0
 
virtual i_widgetparent ()=0
 
virtual void set_parent (i_widget &aParent)=0
 
virtual void parent_changed ()=0
 
virtual bool adding_child () const =0
 
virtual i_widgetadd (i_widget &aChild)=0
 
virtual i_widgetadd (const i_ref_ptr< i_widget > &aChild)=0
 
virtual void remove (i_widget &aChild, bool aSingular, i_ref_ptr< i_widget > &aChildRef)=0
 
virtual void remove_all ()=0
 
virtual bool has_children () const =0
 
virtual const widget_listchildren () const =0
 
virtual widget_list::const_iterator last () const =0
 
virtual widget_list::iterator last ()=0
 
virtual widget_list::const_iterator find (const i_widget &aChild, bool aThrowIfNotFound=true) const =0
 
virtual widget_list::iterator find (const i_widget &aChild, bool aThrowIfNotFound=true)=0
 
virtual void bring_child_to_front (const i_widget &aChild)=0
 
virtual void send_child_to_back (const i_widget &aChild)=0
 
virtual layer_t layer () const =0
 
virtual void set_layer (layer_t aLayer)=0
 
virtual const i_widgetbefore () const =0
 
virtual i_widgetbefore ()=0
 
virtual const i_widgetafter () const =0
 
virtual i_widgetafter ()=0
 
virtual void link_before (i_widget *aPreviousWidget)=0
 
virtual void link_after (i_widget *aNextWidget)=0
 
virtual void unlink ()=0
 
virtual bool has_layout () const =0
 
virtual void set_layout (i_layout &aLayout, bool aMoveExistingItems=true)=0
 
virtual void set_layout (const i_ref_ptr< i_layout > &aLayout, bool aMoveExistingItems=true)=0
 
virtual const i_layoutlayout () const =0
 
virtual i_layoutlayout ()=0
 
virtual bool can_defer_layout () const =0
 
virtual bool has_layout_manager () const =0
 
virtual const i_widgetlayout_manager () const =0
 
virtual i_widgetlayout_manager ()=0
 
virtual bool is_managing_layout () const =0
 
virtual bool has_parent_layout () const =0
 
virtual const i_layoutparent_layout () const =0
 
virtual i_layoutparent_layout ()=0
 
virtual i_optional< neogfx::layout_reason > & layout_reason ()=0
 
virtual void layout_items (bool aDefer=false)=0
 
virtual void layout_items_started ()=0
 
virtual bool layout_items_in_progress () const =0
 
virtual void layout_items_completed ()=0
 
virtual bool has_logical_coordinate_system () const =0
 
virtual neogfx::logical_coordinate_system logical_coordinate_system () const =0
 
virtual void set_logical_coordinate_system (const optional_logical_coordinate_system &aLogicalCoordinateSystem)=0
 
virtual rect non_client_rect () const =0
 
virtual rect client_rect (bool aExtendIntoPadding=true) const =0
 
virtual void move (const point &aPosition)=0
 
virtual void moved ()=0
 
virtual void parent_moved ()=0
 
virtual size extents () const =0
 
virtual bool resizing () const =0
 
virtual void resize (const size &aSize)=0
 
virtual void resized ()=0
 
virtual const i_widgetget_widget_at (const point &aPosition) const =0
 
virtual i_widgetget_widget_at (const point &aPosition)=0
 
virtual neogfx::widget_type widget_type () const =0
 
virtual bool part_active (widget_part aPart) const =0
 
virtual widget_part part (const point &aPosition) const =0
 
virtual widget_part hit_test (const point &aPosition) const =0
 
virtual neogfx::view const & view () const =0
 
virtual neogfx::viewview ()=0
 
virtual layer_t render_layer () const =0
 
virtual void set_render_layer (const std::optional< layer_t > &aLayer)=0
 
virtual bool can_update () const =0
 
virtual bool update (bool aIncludeNonClient=false)=0
 
virtual bool update (const rect &aUpdateRect)=0
 
virtual bool requires_update () const =0
 
virtual rect update_rect () const =0
 
virtual rect default_clip_rect (bool aIncludeNonClient=false) const =0
 
virtual bool ready_to_render () const =0
 
virtual void render (i_graphics_context &aGc) const =0
 
virtual void paint_non_client (i_graphics_context &aGc) const =0
 
virtual void paint_non_client_after (i_graphics_context &aGc) const =0
 
virtual void paint (i_graphics_context &aGc) const =0
 
virtual double opacity () const =0
 
virtual void set_opacity (double aOpacity)=0
 
virtual bool has_background_opacity () const =0
 
virtual double background_opacity () const =0
 
virtual void set_background_opacity (double aOpacity)=0
 
virtual bool has_palette () const =0
 
virtual const i_palettepalette () const =0
 
virtual void set_palette (const i_palette &aPalette)=0
 
virtual bool has_palette_color (color_role aColorRole) const =0
 
virtual color palette_color (color_role aColorRole) const =0
 
virtual void set_palette_color (color_role aColorRole, const optional_color &aColor)=0
 
virtual neogfx::color container_background_color () const =0
 
virtual bool has_font_role () const =0
 
virtual neogfx::font_role font_role () const =0
 
virtual void set_font_role (const optional_font_role &aFontRole)=0
 
virtual bool has_font () const =0
 
virtual const neogfx::font & font () const =0
 
virtual void set_font (optional_font const &aFont)=0
 
virtual bool visible () const =0
 
virtual bool effectively_visible () const =0
 
virtual bool hidden () const =0
 
virtual bool effectively_hidden () const =0
 
virtual bool show (bool aVisible)=0
 
virtual bool enabled () const =0
 
virtual bool effectively_enabled () const =0
 
virtual bool disabled () const =0
 
virtual bool effectively_disabled () const =0
 
virtual bool enable (bool aEnable)=0
 
virtual bool entered (bool aChildEntered=false) const =0
 
virtual bool can_capture () const =0
 
virtual bool capturing () const =0
 
virtual const optional_pointcapture_position () const =0
 
virtual void set_capture (capture_reason aReason=capture_reason::Other, const optional_point &aPosition={})=0
 
virtual void release_capture (capture_reason aReason=capture_reason::Other)=0
 
virtual void non_client_set_capture ()=0
 
virtual void non_client_release_capture ()=0
 
virtual void captured ()=0
 
virtual void capture_released ()=0
 
virtual bool has_focus_policy () const =0
 
virtual neogfx::focus_policy focus_policy () const =0
 
virtual void set_focus_policy (const optional_focus_policy &aFocusPolicy)=0
 
virtual bool can_set_focus (focus_reason aFocusReason) const =0
 
virtual bool has_focus () const =0
 
virtual bool child_has_focus () const =0
 
virtual bool set_focus (focus_reason aFocusReason=focus_reason::Other)=0
 
virtual bool release_focus ()=0
 
virtual void focus_gained (focus_reason aFocusReason)=0
 
virtual void focus_lost (focus_reason aFocusReason)=0
 
virtual bool consider_ancestors_for_mouse_events () const =0
 
virtual void set_consider_ancestors_for_mouse_events (bool aConsiderAncestors=true)=0
 
virtual bool ignore_mouse_events (bool aConsiderAncestors=true) const =0
 
virtual void set_ignore_mouse_events (bool aIgnoreMouseEvents)=0
 
virtual bool ignore_non_client_mouse_events (bool aConsiderAncestors=true) const =0
 
virtual void set_ignore_non_client_mouse_events (bool aIgnoreNonClientMouseEvents)=0
 
virtual neogfx::mouse_event_location mouse_event_location () const =0
 
virtual bool mouse_wheel_scrolled (mouse_wheel aWheel, const point &aPosition, delta aDelta, key_modifiers_e aKeyModifiers)=0
 
virtual void mouse_button_pressed (mouse_button aButton, const point &aPosition, key_modifiers_e aKeyModifiers)=0
 
virtual void mouse_button_double_clicked (mouse_button aButton, const point &aPosition, key_modifiers_e aKeyModifiers)=0
 
virtual void mouse_button_released (mouse_button aButton, const point &aPosition)=0
 
virtual void mouse_moved (const point &aPosition, key_modifiers_e aKeyModifiers)=0
 
virtual void mouse_entered (const point &aPosition)=0
 
virtual void mouse_left ()=0
 
virtual point mouse_position () const =0
 
virtual neogfx::mouse_cursor mouse_cursor () const =0
 
virtual const i_widgetwidget_for_mouse_event (const point &aPosition, bool aForHitTest=false) const =0
 
virtual i_widgetwidget_for_mouse_event (const point &aPosition, bool aForHitTest=false)=0
 
template<typename WidgetType , typename... Args>
WidgetType & emplace (Args &&... args)
 
bool same_surface (const i_widget &aWidget) const
 
bool same_real_surface (const i_widget &aWidget) const
 
bool is_parent_of (const i_widget &aWidget) const
 
bool is_ancestor_of (const i_widget &aWidget) const
 
bool is_descendent_of (const i_widget &aWidget) const
 
bool is_sibling_of (const i_widget &aWidget) const
 
ref_ptr< i_widgetremove (i_widget &aChild, bool aSingular=true)
 
void bring_to_front ()
 
void send_to_back ()
 
point to_window_coordinates (const point &aClientCoordinates) const
 
rect to_window_coordinates (const rect &aClientCoordinates) const
 
point to_client_coordinates (const point &aWindowCoordinates) const
 
rect to_client_coordinates (const rect &aWindowCoordinates) const
 
bool show ()
 
bool hide ()
 
bool enable ()
 
bool disable ()
 
double transparency () const
 
void set_transparency (double aTransparency)
 
double background_transparency () const
 
void set_background_transparency (double aTransparency)
 
bool background_is_transparent () const
 
color effective_background_color () const
 
bool has_background_color () const
 
color background_color () const
 
void set_background_color (const optional_color &aBackgroundColor=optional_color{})
 
bool has_foreground_color () const
 
color foreground_color () const
 
void set_foreground_color (const optional_color &aForegroundColor=optional_color{})
 
bool has_base_color () const
 
color base_color () const
 
void set_base_color (const optional_color &aBaseColor=optional_color{})
 
bool has_alternate_base_color () const
 
color alternate_base_color () const
 
void set_alternate_base_color (const optional_color &aAlternateBaseColor=optional_color{})
 
bool handling_mouse_event () const
 
bool mouse_event_is_client () const
 
bool mouse_event_is_non_client () const
 
virtual const i_widgetas_widget () const=0
 
virtual i_widgetas_widget ()=0
 
- Public Member Functions inherited from neogfx::i_layout_item
virtual ~i_layout_item ()=default
 
virtual const i_stringid () const =0
 
virtual void set_id (const i_string &aId)=0
 
virtual bool is_cache () const =0
 
virtual bool is_layout () const =0
 
virtual const i_layoutas_layout () const =0
 
virtual i_layoutas_layout ()=0
 
virtual bool is_spacer () const =0
 
virtual const i_spacer & as_spacer () const =0
 
virtual i_spacer & as_spacer ()=0
 
virtual bool is_widget () const =0
 
virtual bool has_parent_layout_item () const =0
 
virtual const i_layout_itemparent_layout_item () const =0
 
virtual i_layout_itemparent_layout_item ()=0
 
virtual void set_parent_layout (i_layout *aParentLayout)=0
 
virtual bool has_parent_widget () const =0
 
virtual const i_widgetparent_widget () const =0
 
virtual i_widgetparent_widget ()=0
 
virtual void set_parent_widget (i_widget *aParentWidget)=0
 
virtual void update_layout (bool aDeferLayout=true, bool aAncestors=false)=0
 
virtual void layout_as (const point &aPosition, const size &aSize)=0
 
virtual void invalidate_combined_transformation ()=0
 
virtual void fix_weightings (bool aRecalculate=true)=0
 
virtual void layout_item_enabled (i_layout_item &aItem)=0
 
virtual void layout_item_disabled (i_layout_item &aItem)=0
 
template<typename LayoutType >
bool has_ancestor_layout () const
 
template<typename LayoutType >
LayoutType * find_ancestor_layout ()
 
template<typename LayoutType >
LayoutType & ancestor_layout ()
 
bool same_parent_widget_as (i_layout_item const &aOther) const
 
- Public Member Functions inherited from neolib::i_reference_counted
virtual ~i_reference_counted ()=default
 
virtual void add_ref () const noexcept=0
 
virtual void release () const =0
 
virtual int32_t use_count () const noexcept=0
 
virtual const i_reference_countedrelease_and_take_ownership () const =0
 
virtual i_reference_countedrelease_and_take_ownership ()=0
 
virtual void pin () const noexcept=0
 
virtual void unpin () const =0
 
virtual i_ref_control_blockcontrol_block ()=0
 
- Public Member Functions inherited from neogfx::i_property_owner
virtual ~i_property_owner ()=default
 
virtual void property_changed (i_property &aProperty)=0
 
virtual const i_propertiesproperties () const =0
 
virtual i_propertiesproperties ()=0
 
- Public Member Functions inherited from neogfx::i_object
virtual ~i_object ()=default
 
virtual i_objectas_object ()=0
 
virtual void class_name (neolib::i_string &aClassName) const =0
 
virtual neogfx::object_type object_type () const =0
 
- Public Member Functions inherited from neolib::i_object
 declare_event (destroying)
 
 declare_event (destroyed)
 
- Public Member Functions inherited from neolib::i_lifetime
virtual ~i_lifetime ()=default
 
virtual lifetime_state object_state () const =0
 
virtual std::shared_ptr< std::atomic< lifetime_state > > object_state_ptr () const =0
 
virtual bool is_creating () const =0
 
virtual bool is_alive () const =0
 
virtual bool is_destroying () const =0
 
virtual bool is_destroyed () const =0
 
virtual void set_alive ()=0
 
virtual void set_destroying ()=0
 
virtual void set_destroyed ()=0
 
- Public Member Functions inherited from neogfx::i_anchorable
virtual i_objectas_object ()=0
 
virtual i_anchor & anchor_to (i_anchorable &aRhs, const i_string &aLhsAnchor, anchor_constraint_function aLhsFunction, const i_string &aRhsAnchor, anchor_constraint_function aRhsFunction)=0
 
virtual const anchor_map_typeanchors () const =0
 
virtual anchor_map_typeanchors ()=0
 
i_anchor & anchor_to (i_anchorable &aRhs, std::string const &aLhsAnchor, anchor_constraint_function aLhsFunction, std::string const &aRhsAnchor, anchor_constraint_function aRhsFunction)
 
- Public Member Functions inherited from neogfx::i_keyboard_handler
virtual bool key_pressed (scan_code_e aScanCode, key_code_e aKeyCode, key_modifiers_e aKeyModifiers)=0
 
virtual bool key_released (scan_code_e aScanCode, key_code_e aKeyCode, key_modifiers_e aKeyModifiers)=0
 
virtual bool text_input (i_string const &aText)=0
 
virtual bool sys_text_input (i_string const &aText)=0
 
- Public Member Functions inherited from neogfx::i_skinnable_item
virtual ~i_skinnable_item ()=default
 
virtual bool is_widget () const =0
 
virtual rect element_rect (skin_element aElement) const =0
 

Additional Inherited Members

- Public Attributes inherited from neogfx::i_widget
i_widget i_graphics_context i_graphics_context const neogfx::non_client_mouse_event const neogfx::keyboard_event &declare_event(focus_event, neogfx::focus_event, focus_reason) public typedef neolib::i_vector< i_ref_ptr< i_widget > > widget_list
 

Detailed Description

Definition at line 29 of file i_title_bar.hpp.

Member Typedef Documentation

◆ abstract_type

Constructor & Destructor Documentation

◆ ~i_title_bar()

virtual neogfx::i_title_bar::~i_title_bar ( )
virtualdefault

Member Function Documentation

◆ icon_widget() [1/2]

virtual i_image_widget const & neogfx::i_title_bar::icon_widget ( ) const
pure virtual

◆ icon_widget() [2/2]

virtual i_image_widget & neogfx::i_title_bar::icon_widget ( )
pure virtual

◆ set_icon()

virtual void neogfx::i_title_bar::set_icon ( i_texture const &  aIcon)
pure virtual

◆ set_title()

virtual void neogfx::i_title_bar::set_title ( i_string const &  aTitle)
pure virtual

◆ title()

virtual i_string const & neogfx::i_title_bar::title ( ) const
pure virtual

◆ title_widget() [1/2]

virtual i_text_widget const & neogfx::i_title_bar::title_widget ( ) const
pure virtual

◆ title_widget() [2/2]

virtual i_text_widget & neogfx::i_title_bar::title_widget ( )
pure virtual

The documentation for this class was generated from the following file: