gtksourceviewmm  3.91.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Related Functions | List of all members
Gsv::View Class Reference

The view object. More...

#include <gtksourceviewmm/view.h>

Inheritance diagram for Gsv::View:
Inheritance graph
[legend]

Public Member Functions

 View (View&& src) noexcept
 
Viewoperator= (View&& src) noexcept
 
 View (const View&)=delete
 
Viewoperator= (const View&)=delete
 
 ~View () noexcept override
 
GtkSourceView* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkSourceView* gobj () const
 Provides access to the underlying C GObject. More...
 
 View ()
 Creates a new View. More...
 
 View (const Glib::RefPtr< Buffer >& buffer)
 Creates a new View widget displaying the buffer buffer. More...
 
Glib::RefPtr< const Bufferget_source_buffer () const
 Returns the GtkTextBuffer being displayed by this text view. More...
 
Glib::RefPtr< Bufferget_source_buffer ()
 Returns the GtkTextBuffer being displayed by this text view. More...
 
void set_source_buffer (const Glib::RefPtr< Buffer >& source_buffer)
 Sets a source_buffer as the buffer being displayed by source view. More...
 
void set_show_line_numbers (bool show=true)
 If true line numbers will be displayed beside the text. More...
 
bool get_show_line_numbers () const
 Returns whether line numbers are displayed beside the text. More...
 
void set_tab_width (guint width)
 Sets the width of tabulation in characters. More...
 
guint get_tab_width () const
 Returns the width of tabulation in characters. More...
 
void set_auto_indent (bool enable=true)
 If true auto-indentation of text is enabled. More...
 
bool get_auto_indent () const
 Returns whether auto indentation of text is enabled. More...
 
void set_insert_spaces_instead_of_tabs (bool enable=true)
 If true a tab key pressed is replaced by a group of space characters. More...
 
bool get_insert_spaces_instead_of_tabs () const
 Returns whether when inserting a tabulator character it should be replaced by a group of space characters. More...
 
void set_show_right_margin (bool show=true)
 If true a right margin is displayed. More...
 
bool get_show_right_margin () const
 Returns whether a right margin is displayed. More...
 
void set_highlight_current_line (bool highlight=true)
 If highlight is true the current line is highlighted. More...
 
bool get_highlight_current_line () const
 Returns whether the current line is highlighted. More...
 
void set_right_margin_position (guint margin)
 Sets the position of the right margin. More...
 
guint get_right_margin_position () const
 Gets the position of the right margin. More...
 
void set_smart_home_end (SmartHomeEndType smart_he)
 Set the desired movement of the cursor when HOME and END keys are pressed. More...
 
SmartHomeEndType get_smart_home_end () const
 Returns a SmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed. More...
 
void set_show_line_marks (bool show=true)
 If true line marks will be displayed beside the text. More...
 
bool get_show_line_marks () const
 Returns whether line marks are displayed beside the text. More...
 
void set_indent_on_tab (bool enable=true)
 If true, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the \t characters. More...
 
bool get_indent_on_tab () const
 Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character. More...
 
void set_indent_width (gint width)
 Sets the number of spaces to use for each step of indent. More...
 
gint get_indent_width () const
 Returns the number of spaces to use for each step of indent. More...
 
guint get_visual_column (const Gtk::TextIter& iter) const
 Determines the visual column at iter taking into consideration the indent width of view. More...
 
Glib::RefPtr< Gutterget_gutter (Gtk::TextWindowType window_type)
 Returns the Gutter object associated with window_type for this view. More...
 
Glib::RefPtr< const Gutterget_gutter (Gtk::TextWindowType window_type) const
 Returns the Gutter object associated with window_type for this view. More...
 
Glib::RefPtr< Completionget_completion ()
 Gets the Completion associated with this view. More...
 
Glib::RefPtr< const Completionget_completion () const
 Gets the Completion associated with this view. More...
 
void set_mark_attributes (const Glib::ustring& category, const Glib::RefPtr< MarkAttributes >& attributes, int priority)
 Sets attributes and priority for the category. More...
 
Glib::RefPtr< MarkAttributesget_mark_attributes (const Glib::ustring& category, int& priority)
 Gets attributes and priority for the category. More...
 
Glib::RefPtr< const MarkAttributesget_mark_attributes (const Glib::ustring& category, int& priority) const
 Gets attributes and priority for the category. More...
 
void set_background_pattern (BackgroundPatternType background_pattern)
 Set if and how the background pattern should be displayed. More...
 
BackgroundPatternType get_background_pattern () const
 Returns the GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this view . More...
 
Glib::SignalProxy< void > signal_redo ()
 Emitted when redo action is requested. More...
 
Glib::SignalProxy< void > signal_undo ()
 Emitted when undo action is requested. More...
 
Glib::SignalProxy< void, Gtk::TextIter&, GdkEvent*> signal_line_mark_activated ()
 Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). More...
 
Glib::SignalProxy< void, Gtk::TextIter&, int > signal_smart_home_end ()
 Emitted when a the cursor was moved according to the smart home end setting. More...
 
Glib::PropertyProxy< bool > property_show_line_numbers ()
 Whether to display line numbers. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_show_line_numbers () const
 Whether to display line numbers. More...
 
Glib::PropertyProxy< bool > property_show_line_marks ()
 Whether to display line mark pixbufs. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_show_line_marks () const
 Whether to display line mark pixbufs. More...
 
Glib::PropertyProxy< guint > property_tab_width ()
 Width of a tab character expressed in spaces. More...
 
Glib::PropertyProxy_ReadOnly< guint > property_tab_width () const
 Width of a tab character expressed in spaces. More...
 
Glib::PropertyProxy< int > property_indent_width ()
 Number of spaces to use for each step of indent. More...
 
Glib::PropertyProxy_ReadOnly< int > property_indent_width () const
 Number of spaces to use for each step of indent. More...
 
Glib::PropertyProxy< bool > property_auto_indent ()
 Whether to enable auto indentation. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_auto_indent () const
 Whether to enable auto indentation. More...
 
Glib::PropertyProxy< bool > property_insert_spaces_instead_of_tabs ()
 Whether to insert spaces instead of tabs. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_insert_spaces_instead_of_tabs () const
 Whether to insert spaces instead of tabs. More...
 
Glib::PropertyProxy< bool > property_show_right_margin ()
 Whether to display the right margin. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_show_right_margin () const
 Whether to display the right margin. More...
 
Glib::PropertyProxy< guint > property_right_margin_position ()
 Position of the right margin. More...
 
Glib::PropertyProxy_ReadOnly< guint > property_right_margin_position () const
 Position of the right margin. More...
 
Glib::PropertyProxy< SmartHomeEndTypeproperty_smart_home_end ()
 HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line. More...
 
Glib::PropertyProxy_ReadOnly< SmartHomeEndTypeproperty_smart_home_end () const
 HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line. More...
 
Glib::PropertyProxy< bool > property_highlight_current_line ()
 Whether to highlight the current line. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_highlight_current_line () const
 Whether to highlight the current line. More...
 
Glib::PropertyProxy< bool > property_indent_on_tab ()
 Whether to indent the selected text when the tab key is pressed. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_indent_on_tab () const
 Whether to indent the selected text when the tab key is pressed. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Completion > > property_completion () const
 The completion object associated with the view. More...
 
Glib::PropertyProxy< BackgroundPatternTypeproperty_background_pattern ()
 Draw a specific background pattern on the view. More...
 
Glib::PropertyProxy_ReadOnly< BackgroundPatternTypeproperty_background_pattern () const
 Draw a specific background pattern on the view. More...
 
- Public Member Functions inherited from Gtk::TextView
 TextView (TextView &&src) noexcept
 
TextViewoperator= (TextView &&src) noexcept
 
 TextView (const TextView &)=delete
 
TextViewoperator= (const TextView &)=delete
 
 ~TextView () noexcept override
 
GtkTextView * gobj ()
 
const GtkTextView * gobj () const
 
 TextView ()
 
 TextView (const Glib::RefPtr< TextBuffer > &buffer)
 
void set_buffer (const Glib::RefPtr< TextBuffer > &buffer)
 
Glib::RefPtr< TextBufferget_buffer ()
 
Glib::RefPtr< const TextBufferget_buffer () const
 
bool scroll_to (TextBuffer::iterator &iter, double within_margin=0)
 
bool scroll_to (TextBuffer::iterator &iter, double within_margin, double xalign, double yalign)
 
void scroll_to (const Glib::RefPtr< TextBuffer::Mark > &mark, double within_margin=0)
 
void scroll_to (const Glib::RefPtr< TextBuffer::Mark > &mark, double within_margin, double xalign, double yalign)
 
bool move_mark_onscreen (const Glib::RefPtr< TextBuffer::Mark > &mark)
 
bool place_cursor_onscreen ()
 
void get_visible_rect (Gdk::Rectangle &visible_rect) const
 
void set_cursor_visible (bool setting=true)
 
bool get_cursor_visible () const
 
void reset_cursor_blink ()
 
void get_cursor_locations (const TextBuffer::iterator &iter, Gdk::Rectangle &strong, Gdk::Rectangle &weak) const
 
void get_iter_location (const TextBuffer::iterator &iter, Gdk::Rectangle &location) const
 
void get_iter_at_location (TextBuffer::iterator &iter, int x, int y) const
 
void get_iter_at_position (TextBuffer::iterator &iter, int &trailing, int x, int y) const
 
void get_line_yrange (const TextBuffer::iterator &iter, int &y, int &height) const
 
void get_line_at_y (TextBuffer::iterator &target_iter, int y, int &line_top) const
 
void buffer_to_window_coords (TextWindowType win, int buffer_x, int buffer_y, int &window_x, int &window_y) const
 
void window_to_buffer_coords (TextWindowType win, int window_x, int window_y, int &buffer_x, int &buffer_y) const
 
Glib::RefPtr< Gdk::Windowget_window (TextWindowType win)
 
Glib::RefPtr< const Gdk::Windowget_window (TextWindowType win) const
 
TextWindowType get_window_type (const Glib::RefPtr< Gdk::Window > &window)
 
void set_border_window_size (TextWindowType type, int size)
 
int get_border_window_size (TextWindowType type) const
 
bool forward_display_line (TextBuffer::iterator &iter)
 
bool backward_display_line (TextBuffer::iterator &iter)
 
bool forward_display_line_end (TextBuffer::iterator &iter)
 
bool backward_display_line_start (TextBuffer::iterator &iter)
 
bool starts_display_line (const TextBuffer::iterator &iter)
 
bool move_visually (TextBuffer::iterator &iter, int count)
 
bool im_context_filter_keypress (GdkEventKey *gdk_event)
 
void reset_im_context ()
 
void add_child_at_anchor (Widget &child, const Glib::RefPtr< TextBuffer::ChildAnchor > &anchor)
 
void add_child_in_window (Widget &child, TextWindowType which_window, int xpos, int ypos)
 
void move_child (Widget &child, int xpos, int ypos)
 
void set_wrap_mode (WrapMode wrap_mode)
 
WrapMode get_wrap_mode () const
 
void set_editable (bool setting=true)
 
bool get_editable () const
 
void set_pixels_above_lines (int pixels_above_lines)
 
int get_pixels_above_lines () const
 
void set_pixels_below_lines (int pixels_below_lines)
 
int get_pixels_below_lines () const
 
void set_pixels_inside_wrap (int pixels_inside_wrap)
 
int get_pixels_inside_wrap () const
 
void set_justification (Justification justification)
 
Justification get_justification () const
 
void set_left_margin (int left_margin)
 
int get_left_margin () const
 
void set_right_margin (int right_margin)
 
int get_right_margin () const
 
void set_top_margin (int top_margin)
 
int get_top_margin () const
 
void set_bottom_margin (int bottom_margin)
 
int get_bottom_margin () const
 
void set_indent (int indent)
 
int get_indent () const
 
void set_tabs (Pango::TabArray &tabs)
 
Pango::TabArray get_tabs () const
 
TextAttributes get_default_attributes () const
 
void set_overwrite (bool overwrite=true)
 
bool get_overwrite () const
 
void set_accepts_tab (bool accepts_tab=true)
 
bool get_accepts_tab () const
 
void set_input_purpose (InputPurpose purpose)
 
InputPurpose get_input_purpose () const
 
void set_input_hints (InputHints hints)
 
InputHints get_input_hints () const
 
void set_monospace (bool monospace=true)
 
bool get_monospace () const
 
Glib::SignalProxy< void, Menu * > signal_populate_popup ()
 
Glib::SignalProxy< void > signal_set_anchor ()
 
Glib::SignalProxy< void, const Glib::ustring & > signal_insert_at_cursor ()
 
Glib::PropertyProxy< int > property_pixels_above_lines ()
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_above_lines () const
 
Glib::PropertyProxy< int > property_pixels_below_lines ()
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_below_lines () const
 
Glib::PropertyProxy< int > property_pixels_inside_wrap ()
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_inside_wrap () const
 
Glib::PropertyProxy< bool > property_editable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_editable () const
 
Glib::PropertyProxy< WrapModeproperty_wrap_mode ()
 
Glib::PropertyProxy_ReadOnly< WrapModeproperty_wrap_mode () const
 
Glib::PropertyProxy< Justificationproperty_justification ()
 
Glib::PropertyProxy_ReadOnly< Justificationproperty_justification () const
 
Glib::PropertyProxy< int > property_left_margin ()
 
Glib::PropertyProxy_ReadOnly< int > property_left_margin () const
 
Glib::PropertyProxy< int > property_right_margin ()
 
Glib::PropertyProxy_ReadOnly< int > property_right_margin () const
 
Glib::PropertyProxy< int > property_top_margin ()
 
Glib::PropertyProxy_ReadOnly< int > property_top_margin () const
 
Glib::PropertyProxy< int > property_bottom_margin ()
 
Glib::PropertyProxy_ReadOnly< int > property_bottom_margin () const
 
Glib::PropertyProxy< int > property_indent ()
 
Glib::PropertyProxy_ReadOnly< int > property_indent () const
 
Glib::PropertyProxy< Pango::TabArrayproperty_tabs ()
 
Glib::PropertyProxy_ReadOnly< Pango::TabArrayproperty_tabs () const
 
Glib::PropertyProxy< bool > property_cursor_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_cursor_visible () const
 
Glib::PropertyProxy< Glib::RefPtr< TextBuffer > > property_buffer ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TextBuffer > > property_buffer () const
 
Glib::PropertyProxy< bool > property_overwrite ()
 
Glib::PropertyProxy_ReadOnly< bool > property_overwrite () const
 
Glib::PropertyProxy< bool > property_accepts_tab ()
 
Glib::PropertyProxy_ReadOnly< bool > property_accepts_tab () const
 
Glib::PropertyProxy< Glib::ustringproperty_im_module ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_im_module () const
 
Glib::PropertyProxy< InputPurposeproperty_input_purpose ()
 
Glib::PropertyProxy_ReadOnly< InputPurposeproperty_input_purpose () const
 
Glib::PropertyProxy< InputHintsproperty_input_hints ()
 
Glib::PropertyProxy_ReadOnly< InputHintsproperty_input_hints () const
 
Glib::PropertyProxy< bool > property_populate_all ()
 
Glib::PropertyProxy_ReadOnly< bool > property_populate_all () const
 
Glib::PropertyProxy< bool > property_monospace ()
 
Glib::PropertyProxy_ReadOnly< bool > property_monospace () const
 
Gtk::TextViewwrap (GtkTextView *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::Container
 Container (Container &&src) noexcept
 
Containeroperator= (Container &&src) noexcept
 
 Container (const Container &)=delete
 
Containeroperator= (const Container &)=delete
 
 ~Container () noexcept override
 
GtkContainer * gobj ()
 
const GtkContainer * gobj () const
 
void set_border_width (guint border_width)
 
guint get_border_width () const
 
virtual void add (Widget &widget)
 
void remove (Widget &widget)
 
void set_resize_mode (ResizeMode resize_mode)
 
ResizeMode get_resize_mode () const
 
void check_resize ()
 
void foreach (const ForeachSlot &slot)
 
void forall (const ForeachSlot &slot)
 
std::vector< Widget *> get_children ()
 
std::vector< const Widget *> get_children () const
 
void propagate_draw (Widget &child, const ::Cairo::RefPtr< ::Cairo::Context > &cr)
 
void set_focus_chain (const std::vector< Widget * > &focusable_widgets)
 
bool has_focus_chain () const
 
std::vector< Widget *> get_focus_chain ()
 
std::vector< const Widget *> get_focus_chain () const
 
void unset_focus_chain ()
 
void set_reallocate_redraws (bool needs_redraws=true)
 
void set_focus_child (Widget &widget)
 
Widgetget_focus_child ()
 
const Widgetget_focus_child () const
 
void set_focus_vadjustment (const Glib::RefPtr< Adjustment > &adjustment)
 
Glib::RefPtr< Adjustmentget_focus_vadjustment ()
 
Glib::RefPtr< const Adjustmentget_focus_vadjustment () const
 
void set_focus_hadjustment (const Glib::RefPtr< Adjustment > &adjustment)
 
Glib::RefPtr< Adjustmentget_focus_hadjustment ()
 
Glib::RefPtr< const Adjustmentget_focus_hadjustment () const
 
void resize_children ()
 
GType child_type () const
 
WidgetPath get_path_for_child (const Widget &child) const
 
Glib::SignalProxy< void, Widget * > signal_add ()
 
Glib::SignalProxy< void, Widget * > signal_remove ()
 
Glib::SignalProxy< void > signal_check_resize ()
 
Glib::SignalProxy< void, Widget * > signal_set_focus_child ()
 
void show_all_children (bool recursive=true)
 
Gtk::Containerwrap (GtkContainer *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget &&src) noexcept
 
Widgetoperator= (Widget &&src) noexcept
 
 Widget (const Widget &)=delete
 
Widgetoperator= (const Widget &)=delete
 
 ~Widget () noexcept override
 
GtkWidget * gobj ()
 
const GtkWidget * gobj () const
 
void show ()
 
void show_now ()
 
void hide ()
 
void show_all ()
 
void queue_draw ()
 
void queue_draw_area (int x, int y, int width, int height)
 
void queue_draw_region (const ::Cairo::RefPtr< const ::Cairo::Region > &region)
 
void queue_resize ()
 
void queue_allocate ()
 
void size_allocate (const Allocation &allocation)
 
void size_allocate (const Allocation &allocation, int baseline)
 
SizeRequestMode get_request_mode () const
 
void get_preferred_width (int &minimum_width, int &natural_width) const
 
void get_preferred_height_for_width (int width, int &minimum_height, int &natural_height) const
 
void get_preferred_height_for_width (int width, int &minimum_height, int &natural_height, int &minimum_baseline, int &natural_baseline) const
 
void get_preferred_height (int &minimum_height, int &natural_height) const
 
void get_preferred_width_for_height (int height, int &minimum_width, int &natural_width) const
 
void get_preferred_size (Requisition &minimum_size, Requisition &natural_size) const
 
void add_accelerator (const Glib::ustring &accel_signal, const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 
bool remove_accelerator (const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 
void set_accel_path (const Glib::ustring &accel_path, const Glib::RefPtr< AccelGroup > &accel_group)
 
bool mnemonic_activate (bool group_cycling)
 
bool event (GdkEvent *gdk_event)
 
int send_expose (GdkEvent *gdk_event)
 
bool send_focus_change (GdkEvent *gdk_event)
 
bool activate ()
 
void reparent (Widget &new_parent)
 
bool intersect (const Gdk::Rectangle &area) const
 
bool intersect (const Gdk::Rectangle &area, Gdk::Rectangle &intersection) const
 
::Cairo::RefPtr< ::Cairo::Regionregion_intersect (const ::Cairo::RefPtr< ::Cairo::Region > &region) const
 
void freeze_child_notify ()
 
void child_notify (const Glib::ustring &child_property)
 
void thaw_child_notify ()
 
void set_can_focus (bool can_focus=true)
 
bool get_can_focus () const
 
bool has_focus () const
 
bool is_focus () const
 
bool has_visible_focus () const
 
void grab_focus ()
 
void set_focus_on_click (bool focus_on_click=true)
 
bool get_focus_on_click () const
 
void set_can_default (bool can_default=true)
 
bool get_can_default () const
 
bool has_default () const
 
void grab_default ()
 
void set_receives_default (bool receives_default=true)
 
bool get_receives_default () const
 
bool has_grab () const
 
bool device_is_shadowed (const Glib::RefPtr< const Gdk::Device > &device)
 
void add_modal_grab ()
 
void remove_modal_grab ()
 
void set_name (const Glib::ustring &name)
 
void unset_name ()
 
Glib::ustring get_name () const
 
void set_state (StateType state)
 
StateType get_state () const
 
void set_state_flags (StateFlags flags, bool clear=true)
 
void unset_state_flags (StateFlags flags)
 
StateFlags get_state_flags () const
 
void set_sensitive (bool sensitive=true)
 
bool get_sensitive () const
 
bool is_sensitive () const
 
void set_visible (bool visible=true)
 
bool get_visible () const
 
bool is_visible () const
 
bool get_has_window () const
 
bool get_is_toplevel () const
 
bool get_is_drawable () const
 
bool get_realized () const
 
bool get_mapped () const
 
void set_app_paintable (bool app_paintable=true)
 
bool get_app_paintable () const
 
void set_double_buffered (bool double_buffered=true)
 
bool get_double_buffered () const
 
void set_redraw_on_allocate (bool redraw_on_allocate=true)
 
void set_child_visible (bool visible=true)
 
bool get_child_visible () const
 
Glib::RefPtr< Gdk::Windowget_window ()
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
void register_window (const Glib::RefPtr< Gdk::Window > &window)
 
void unregister_window (const Glib::RefPtr< Gdk::Window > &window)
 
int get_allocated_width () const
 
int get_allocated_height () const
 
int get_allocated_baseline () const
 
void get_allocated_size (Allocation &allocation, int &baseline) const
 
Allocation get_allocation () const
 
void set_allocation (const Allocation &allocation)
 
void set_clip (const Allocation &clip)
 
Allocation get_clip () const
 
Containerget_parent ()
 
const Containerget_parent () const
 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 
void set_parent_window (const Glib::RefPtr< const Gdk::Window > &parent_window)
 
bool child_focus (DirectionType direction)
 
bool keynav_failed (DirectionType direction)
 
void error_bell ()
 
void set_size_request (int width=-1, int height=-1)
 
void get_size_request (int &width, int &height) const
 
void set_events (Gdk::EventMask events)
 
void add_events (Gdk::EventMask events)
 
void set_device_events (const Glib::RefPtr< const Gdk::Device > &device, Gdk::EventMask events)
 
void add_device_events (const Glib::RefPtr< const Gdk::Device > &device, Gdk::EventMask events)
 
void set_opacity (double opacity)
 
double get_opacity () const
 
void set_device_enabled (const Glib::RefPtr< Gdk::Device > &device, bool enabled=true)
 
bool get_device_enabled (const Glib::RefPtr< const Gdk::Device > &device) const
 
Containerget_toplevel ()
 
const Containerget_toplevel () const
 
Widgetget_ancestor (GType widget_type)
 
const Widgetget_ancestor (GType widget_type) const
 
Glib::RefPtr< Gdk::Visualget_visual ()
 
Glib::RefPtr< Gdk::Screenget_screen ()
 
Glib::RefPtr< const Gdk::Screenget_screen () const
 
bool has_screen () const
 
int get_scale_factor () const
 
Glib::RefPtr< Gdk::Displayget_display ()
 
Glib::RefPtr< const Gdk::Displayget_display () const
 
Glib::RefPtr< Gdk::Windowget_root_window ()
 
Glib::RefPtr< const Gdk::Windowget_root_window () const
 
Glib::RefPtr< Settingsget_settings ()
 
Glib::RefPtr< Clipboardget_clipboard (const Glib::ustring &selection)
 
Glib::RefPtr< const Clipboardget_clipboard (const Glib::ustring &selection) const
 
bool get_hexpand () const
 
void set_hexpand (bool expand=true)
 
bool get_hexpand_set () const
 
void set_hexpand_set (bool set=true)
 
bool get_vexpand () const
 
void set_vexpand (bool expand=true)
 
bool get_vexpand_set () const
 
void set_vexpand_set (bool set=true)
 
void queue_compute_expand ()
 
bool compute_expand (Orientation orientation)
 
bool get_support_multidevice () const
 
void set_support_multidevice (bool support_multidevice=true)
 
Glib::RefPtr< Atk::Object > get_accessible ()
 
Glib::RefPtr< const Atk::Object > get_accessible () const
 
Align get_halign () const
 
void set_halign (Align align)
 
Align get_valign () const
 
Align get_valign_with_baseline () const
 
void set_valign (Align align)
 
int get_margin_left () const
 
void set_margin_left (int margin)
 
int get_margin_right () const
 
void set_margin_right (int margin)
 
int get_margin_start () const
 
void set_margin_start (int margin)
 
int get_margin_end () const
 
void set_margin_end (int margin)
 
int get_margin_top () const
 
void set_margin_top (int margin)
 
int get_margin_bottom () const
 
void set_margin_bottom (int margin)
 
Gdk::EventMask get_events () const
 
Gdk::EventMask get_device_events (const Glib::RefPtr< const Gdk::Device > &device) const
 
void get_pointer (int &x, int &y) const
 
bool is_ancestor (Widget &ancestor) const
 
bool translate_coordinates (Widget &dest_widget, int src_x, int src_y, int &dest_x, int &dest_y)
 
void override_color (const Gdk::RGBA &color, StateFlags state=STATE_FLAG_NORMAL)
 
void unset_color (StateFlags state=STATE_FLAG_NORMAL)
 
void override_background_color (const Gdk::RGBA &color, StateFlags state=STATE_FLAG_NORMAL)
 
void unset_background_color (StateFlags state=STATE_FLAG_NORMAL)
 
void override_font (const Pango::FontDescription &font_desc)
 
void unset_font ()
 
void override_symbolic_color (const Glib::ustring &name, const Gdk::RGBA &color)
 
void unset_symbolic_color (const Glib::ustring &name)
 
void override_cursor (const Gdk::RGBA &cursor, const Gdk::RGBA &secondary_cursor)
 
void unset_cursor ()
 
void reset_style ()
 
void get_style_property (const Glib::ustring &the_property_name, PropertyType &value) const
 
Glib::RefPtr< Pango::Contextcreate_pango_context ()
 
Glib::RefPtr< Pango::Contextget_pango_context ()
 
void set_font_options (const ::Cairo::FontOptions &options)
 
void unset_font_options ()
 
::Cairo::FontOptions get_font_options () const
 
Glib::RefPtr< Pango::Layoutcreate_pango_layout (const Glib::ustring &text)
 
Glib::RefPtr< Gdk::Pixbufrender_icon_pixbuf (const StockID &stock_id, IconSize size)
 
void set_composite_name (const Glib::ustring &name)
 
void unset_composite_name ()
 
Glib::ustring get_composite_name () const
 
void set_direction (TextDirection dir)
 
TextDirection get_direction () const
 
void shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region > &region)
 
void input_shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region > &region)
 
WidgetPath get_path () const
 
std::vector< Widget *> list_mnemonic_labels ()
 
std::vector< const Widget *> list_mnemonic_labels () const
 
void add_mnemonic_label (Widget &label)
 
void remove_mnemonic_label (Widget &label)
 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::ustring &target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const std::vector< TargetEntry > &targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window > &proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 
void drag_dest_unset ()
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::RefPtr< TargetList > &target_list) const
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList > &target_list)
 
void drag_dest_add_text_targets ()
 
void drag_dest_add_image_targets ()
 
void drag_dest_add_uri_targets ()
 
void drag_source_set (const std::vector< TargetEntry > &targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)
 
void drag_source_set_icon (const StockID &stock_id)
 
void drag_source_set_icon (const Glib::ustring &icon_name)
 
void drag_source_add_text_targets ()
 
void drag_source_add_uri_targets ()
 
void drag_source_add_image_targets ()
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList > &targets, Gdk::DragAction actions, int button, GdkEvent *gdk_event)
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList > &targets, Gdk::DragAction actions, int button, GdkEvent *gdk_event, int x, int y)
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 
void drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext > &context, int hot_x, int hot_y)
 
void queue_resize_no_redraw ()
 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 
bool get_no_show_all () const
 
void set_no_show_all (bool no_show_all=true)
 
void set_parent (Widget &parent)
 
void unparent ()
 
void map ()
 
void unmap ()
 
void draw_insertion_cursor (const ::Cairo::RefPtr< ::Cairo::Context > &cr, const Gdk::Rectangle &location, bool is_primary, TextDirection direction, bool draw_arrow=true)
 
void set_tooltip_window (Window &custom_window)
 
Windowget_tooltip_window ()
 
void trigger_tooltip_query ()
 
void set_tooltip_text (const Glib::ustring &text)
 
Glib::ustring get_tooltip_text () const
 
void set_tooltip_markup (const Glib::ustring &markup)
 
Glib::ustring get_tooltip_markup () const
 
void set_has_tooltip (bool has_tooltip=TRUE)
 
bool get_has_tooltip () const
 
int get_width () const
 
int get_height () const
 
bool is_composited () const
 
bool in_destruction () const
 
Glib::RefPtr< StyleContextget_style_context ()
 
Glib::RefPtr< Gtk::StyleContextget_style_context () const
 
Gdk::ModifierType get_modifier_mask (Gdk::ModifierIntent intent)
 
guint add_tick_callback (const SlotTick &slot)
 
void remove_tick_callback (guint id)
 
void insert_action_group (const Glib::ustring &name, const Glib::RefPtr< Gio::ActionGroup > &group)
 
void remove_action_group (const Glib::ustring &name)
 
Glib::RefPtr< Gio::ActionGroupget_action_group (const Glib::ustring &prefix)
 
Glib::RefPtr< const Gio::ActionGroupget_action_group (const Glib::ustring &prefix) const
 
std::vector< Glib::ustringlist_action_prefixes () const
 
void set_font_map (const Glib::RefPtr< Pango::FontMap > &font_map)
 
Glib::RefPtr< Pango::FontMapget_font_map ()
 
Glib::RefPtr< const Pango::FontMapget_font_map () const
 
Glib::SignalProxy< void > signal_show ()
 
Glib::SignalProxy< void > signal_hide ()
 
Glib::SignalProxy< void > signal_map ()
 
Glib::SignalProxy< void > signal_unmap ()
 
Glib::SignalProxy< void > signal_realize ()
 
Glib::SignalProxy< void > signal_unrealize ()
 
Glib::SignalProxy< void, Allocation & > signal_size_allocate ()
 
Glib::SignalProxy< void, Gtk::StateTypesignal_state_changed ()
 
Glib::SignalProxy< void, Gtk::StateFlagssignal_state_flags_changed ()
 
Glib::SignalProxy< void, Widget * > signal_parent_changed ()
 
Glib::SignalProxy< void, Widget * > signal_hierarchy_changed ()
 
Glib::SignalProxy< void > signal_style_updated ()
 
Glib::SignalProxy< void, TextDirectionsignal_direction_changed ()
 
Glib::SignalProxy< void, bool > signal_grab_notify ()
 
Glib::SignalProxy< void, GParamSpec * > signal_child_notify ()
 
Glib::SignalProxyDetailedAnyType< void, GParamSpec * > signal_child_notify (const Glib::ustring &child_property_name)
 
Glib::SignalProxy< bool, bool > signal_mnemonic_activate ()
 
Glib::SignalProxy< void > signal_grab_focus ()
 
Glib::SignalProxy< bool, DirectionTypesignal_focus ()
 
Glib::SignalProxy< bool, GdkEvent * > signal_event ()
 
Glib::SignalProxy< void, GdkEvent * > signal_event_after ()
 
Glib::SignalProxy< bool, GdkEventButton * > signal_button_press_event ()
 
Glib::SignalProxy< bool, GdkEventButton * > signal_button_release_event ()
 
Glib::SignalProxy< bool, GdkEventScroll * > signal_scroll_event ()
 
Glib::SignalProxy< bool, GdkEventMotion * > signal_motion_notify_event ()
 
Glib::SignalProxy< bool, GdkEventAny * > signal_delete_event ()
 
Glib::SignalProxy< bool, const ::Cairo::RefPtr< ::Cairo::Context > & > signal_draw ()
 
Glib::SignalProxy< bool, GdkEventKey * > signal_key_press_event ()
 
Glib::SignalProxy< bool, GdkEventKey * > signal_key_release_event ()
 
Glib::SignalProxy< bool, GdkEventCrossing * > signal_enter_notify_event ()
 
Glib::SignalProxy< bool, GdkEventCrossing * > signal_leave_notify_event ()
 
Glib::SignalProxy< bool, GdkEventConfigure * > signal_configure_event ()
 
Glib::SignalProxy< bool, GdkEventFocus * > signal_focus_in_event ()
 
Glib::SignalProxy< bool, GdkEventFocus * > signal_focus_out_event ()
 
Glib::SignalProxy< bool, GdkEventAny * > signal_map_event ()
 
Glib::SignalProxy< bool, GdkEventAny * > signal_unmap_event ()
 
Glib::SignalProxy< bool, GdkEventProperty * > signal_property_notify_event ()
 
Glib::SignalProxy< bool, GdkEventSelection * > signal_selection_clear_event ()
 
Glib::SignalProxy< bool, GdkEventSelection * > signal_selection_request_event ()
 
Glib::SignalProxy< bool, GdkEventSelection * > signal_selection_notify_event ()
 
Glib::SignalProxy< bool, GdkEventProximity * > signal_proximity_in_event ()
 
Glib::SignalProxy< bool, GdkEventProximity * > signal_proximity_out_event ()
 
Glib::SignalProxy< bool, GdkEventVisibility * > signal_visibility_notify_event ()
 
Glib::SignalProxy< bool, GdkEventWindowState * > signal_window_state_event ()
 
Glib::SignalProxy< void, SelectionData &, guint, guint > signal_selection_get ()
 
Glib::SignalProxy< void, const SelectionData &, guint > signal_selection_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_begin ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_end ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, SelectionData &, guint, guint > signal_drag_data_get ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_data_delete ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, DragResultsignal_drag_failed ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, guint > signal_drag_leave ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_motion ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_drop ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, int, int, const SelectionData &, guint, guint > signal_drag_data_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::Screen > & > signal_screen_changed ()
 
Glib::SignalProxy< void > signal_composited_changed ()
 
Glib::SignalProxy< bool > signal_popup_menu ()
 
Glib::SignalProxy< bool, int, int, bool, const Glib::RefPtr< Tooltip > & > signal_query_tooltip ()
 
Glib::SignalProxy< bool, GdkEventGrabBroken * > signal_grab_broken_event ()
 
Glib::SignalProxy< bool, GdkEventExpose * > signal_damage_event ()
 
Glib::SignalProxy< bool, GdkEventTouch * > signal_touch_event ()
 
Glib::PropertyProxy< Glib::ustringproperty_name ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 
Glib::PropertyProxy< Container * > property_parent ()
 
Glib::PropertyProxy_ReadOnly< Container * > property_parent () const
 
Glib::PropertyProxy< int > property_width_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 
Glib::PropertyProxy< int > property_height_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< bool > property_app_paintable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_app_paintable () const
 
Glib::PropertyProxy< bool > property_can_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 
Glib::PropertyProxy< bool > property_has_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 
Glib::PropertyProxy< bool > property_is_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 
Glib::PropertyProxy< bool > property_focus_on_click ()
 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 
Glib::PropertyProxy< bool > property_can_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_default () const
 
Glib::PropertyProxy< bool > property_has_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 
Glib::PropertyProxy< bool > property_receives_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 
Glib::PropertyProxy_ReadOnly< bool > property_composite_child () const
 
Glib::PropertyProxy< Glib::RefPtr< Style > > property_style ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > property_style () const
 
Glib::PropertyProxy< Gdk::EventMaskproperty_events ()
 
Glib::PropertyProxy_ReadOnly< Gdk::EventMaskproperty_events () const
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_markup ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_markup () const
 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_text ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_text () const
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > property_window () const
 
Glib::PropertyProxy< bool > property_no_show_all ()
 
Glib::PropertyProxy_ReadOnly< bool > property_no_show_all () const
 
Glib::PropertyProxy< bool > property_double_buffered ()
 
Glib::PropertyProxy_ReadOnly< bool > property_double_buffered () const
 
Glib::PropertyProxy< Alignproperty_halign ()
 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 
Glib::PropertyProxy< Alignproperty_valign ()
 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 
Glib::PropertyProxy< int > property_margin_left ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_left () const
 
Glib::PropertyProxy< int > property_margin_right ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_right () const
 
Glib::PropertyProxy< int > property_margin_start ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 
Glib::PropertyProxy< int > property_margin_end ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 
Glib::PropertyProxy< int > property_margin_top ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 
Glib::PropertyProxy< int > property_margin_bottom ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 
Glib::PropertyProxy< int > property_margin ()
 
Glib::PropertyProxy_ReadOnly< int > property_margin () const
 
Glib::PropertyProxy< bool > property_hexpand ()
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 
Glib::PropertyProxy< bool > property_hexpand_set ()
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 
Glib::PropertyProxy< bool > property_vexpand ()
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 
Glib::PropertyProxy< bool > property_vexpand_set ()
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 
Glib::PropertyProxy< bool > property_expand ()
 
Glib::PropertyProxy_ReadOnly< bool > property_expand () const
 
Glib::PropertyProxy< double > property_opacity ()
 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 
Gtk::Widgetwrap (GtkWidget *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::Object
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
 ~Object () noexcept override
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable &&src) noexcept
 
Buildableoperator= (Buildable &&src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable * gobj ()
 
const GtkBuildable * gobj () const
 
void set_name (const Glib::ustring &name)
 
Glib::ustring get_name () const
 
Glib::RefPtr< Gtk::Buildablewrap (GtkBuildable *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Gtk::Scrollable
 Scrollable (Scrollable &&src) noexcept
 
Scrollableoperator= (Scrollable &&src) noexcept
 
 ~Scrollable () noexcept override
 
GtkScrollable * gobj ()
 
const GtkScrollable * gobj () const
 
Glib::RefPtr< Adjustmentget_hadjustment ()
 
Glib::RefPtr< const Adjustmentget_hadjustment () const
 
void set_hadjustment (const Glib::RefPtr< Adjustment > &hadjustment)
 
void unset_hadjustment ()
 
Glib::RefPtr< Adjustmentget_vadjustment ()
 
Glib::RefPtr< const Adjustmentget_vadjustment () const
 
void set_vadjustment (const Glib::RefPtr< Adjustment > &vadjustment)
 
void unset_vadjustment ()
 
ScrollablePolicy get_hscroll_policy () const
 
void set_hscroll_policy (ScrollablePolicy policy)
 
ScrollablePolicy get_vscroll_policy () const
 
void set_vscroll_policy (ScrollablePolicy policy)
 
bool get_border (Border &border) const
 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_hadjustment ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_hadjustment () const
 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_vadjustment ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_vadjustment () const
 
Glib::PropertyProxy< ScrollablePolicyproperty_hscroll_policy ()
 
Glib::PropertyProxy_ReadOnly< ScrollablePolicyproperty_hscroll_policy () const
 
Glib::PropertyProxy< ScrollablePolicyproperty_vscroll_policy ()
 
Glib::PropertyProxy_ReadOnly< ScrollablePolicyproperty_vscroll_policy () const
 
Glib::RefPtr< Gtk::Scrollablewrap (GtkScrollable *object, bool take_copy=false)
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gtk::TextView
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::Container
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 
static Widgetget_current_modal_grab ()
 
static void push_composite_child ()
 
static void pop_composite_child ()
 
static void set_default_direction (TextDirection dir)
 
static TextDirection get_default_direction ()
 
static Widgetdrag_get_source_widget (const Glib::RefPtr< Gdk::DragContext > &context)
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::Scrollable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 

Static Public Attributes

static const int gutter_position_lines = -30
 The gutter position of the lines renderer. More...
 
static const int gutter_position_marks = -20
 The gutter position of the marks renderer. More...
 

Protected Member Functions

virtual void on_redo ()
 This is a default handler for the signal signal_redo(). More...
 
virtual void on_undo ()
 This is a default handler for the signal signal_undo(). More...
 
virtual void on_line_mark_activated (Gtk::TextIter& mark, GdkEvent*event)
 This is a default handler for the signal signal_line_mark_activated(). More...
 
- Protected Member Functions inherited from Gtk::TextView
virtual void on_populate_popup (Menu *menu)
 
virtual void on_set_anchor ()
 
virtual void on_insert_at_cursor (const Glib::ustring &str)
 
- Protected Member Functions inherited from Gtk::Container
virtual void on_add (Widget *widget)
 
virtual void on_remove (Widget *widget)
 
virtual void on_check_resize ()
 
virtual void on_set_focus_child (Widget *widget)
 
 Container ()
 
virtual GType child_type_vfunc () const
 
virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
 
virtual char * composite_name_vfunc (GtkWidget *child)
 
virtual void set_child_property_vfunc (GtkWidget *child, guint property_id, const GValue *value, GParamSpec *pspec)
 
virtual void get_child_property_vfunc (GtkWidget *child, guint property_id, GValue *value, GParamSpec *pspec) const
 
Glib::PropertyProxy< guint > property_border_width ()
 
Glib::PropertyProxy_ReadOnly< guint > property_border_width () const
 
Glib::PropertyProxy< ResizeModeproperty_resize_mode ()
 
Glib::PropertyProxy_ReadOnly< ResizeModeproperty_resize_mode () const
 
Glib::PropertyProxy_WriteOnly< Widget * > property_child ()
 
- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
 
virtual void on_hide ()
 
virtual void on_map ()
 
virtual void on_unmap ()
 
virtual void on_realize ()
 
virtual void on_unrealize ()
 
virtual void on_size_allocate (Allocation &allocation)
 
virtual void on_state_changed (Gtk::StateType previous_state)
 
virtual void on_parent_changed (Widget *previous_parent)
 
virtual void on_hierarchy_changed (Widget *previous_toplevel)
 
virtual void on_style_updated ()
 
virtual void on_direction_changed (TextDirection direction)
 
virtual void on_grab_notify (bool was_grabbed)
 
virtual void on_child_notify (GParamSpec *pspec)
 
virtual bool on_mnemonic_activate (bool group_cycling)
 
virtual void on_grab_focus ()
 
virtual bool on_focus (DirectionType direction)
 
virtual bool on_event (GdkEvent *gdk_event)
 
virtual bool on_button_press_event (GdkEventButton *button_event)
 
virtual bool on_button_release_event (GdkEventButton *release_event)
 
virtual bool on_scroll_event (GdkEventScroll *scroll_event)
 
virtual bool on_motion_notify_event (GdkEventMotion *motion_event)
 
virtual bool on_delete_event (GdkEventAny *any_event)
 
virtual bool on_draw (const ::Cairo::RefPtr< ::Cairo::Context > &cr)
 
virtual bool on_key_press_event (GdkEventKey *key_event)
 
virtual bool on_key_release_event (GdkEventKey *key_event)
 
virtual bool on_enter_notify_event (GdkEventCrossing *crossing_event)
 
virtual bool on_leave_notify_event (GdkEventCrossing *crossing_event)
 
virtual bool on_configure_event (GdkEventConfigure *configure_event)
 
virtual bool on_focus_in_event (GdkEventFocus *focus_event)
 
virtual bool on_focus_out_event (GdkEventFocus *gdk_event)
 
virtual bool on_map_event (GdkEventAny *any_event)
 
virtual bool on_unmap_event (GdkEventAny *any_event)
 
virtual bool on_property_notify_event (GdkEventProperty *property_event)
 
virtual bool on_selection_clear_event (GdkEventSelection *selection_event)
 
virtual bool on_selection_request_event (GdkEventSelection *selection_event)
 
virtual bool on_selection_notify_event (GdkEventSelection *selection_event)
 
virtual bool on_proximity_in_event (GdkEventProximity *proximity_event)
 
virtual bool on_proximity_out_event (GdkEventProximity *proximity_event)
 
virtual bool on_visibility_notify_event (GdkEventVisibility *visibility_event)
 
virtual bool on_window_state_event (GdkEventWindowState *window_state_event)
 
virtual void on_selection_get (SelectionData &selection_data, guint info, guint time)
 
virtual void on_selection_received (const SelectionData &selection_data, guint time)
 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::DragContext > &context)
 
virtual void on_drag_end (const Glib::RefPtr< Gdk::DragContext > &context)
 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::DragContext > &context, SelectionData &selection_data, guint info, guint time)
 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext > &context)
 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::DragContext > &context, guint time)
 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, const SelectionData &selection_data, guint info, guint time)
 
virtual void on_screen_changed (const Glib::RefPtr< Gdk::Screen > &previous_screen)
 
virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec **p2)
 
virtual void show_all_vfunc ()
 
virtual Glib::RefPtr< Atk::Object > get_accessible_vfunc ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void get_preferred_width_vfunc (int &minimum_width, int &natural_width) const
 
virtual void get_preferred_height_for_width_vfunc (int width, int &minimum_height, int &natural_height) const
 
virtual void get_preferred_height_vfunc (int &minimum_height, int &natural_height) const
 
virtual void get_preferred_width_for_height_vfunc (int height, int &minimum_width, int &natural_width) const
 
 Widget ()
 
void realize ()
 
void unrealize ()
 
void draw (const ::Cairo::RefPtr< ::Cairo::Context > &cr)
 
void set_mapped (bool mapped=true)
 
void set_realized (bool realized=true)
 
void set_has_window (bool has_window=true)
 
void set_window (const Glib::RefPtr< Gdk::Window > &window)
 
void transform_cairo_context_to_window (const ::Cairo::RefPtr< ::Cairo::Context > &cr, const Glib::RefPtr< const Gdk::Window > &window)
 
Requisition get_requisition () const
 
void get_style_property_value (const Glib::ustring &the_property_name, Glib::ValueBase &value) const
 
void realize_if_needed ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 
- Protected Member Functions inherited from Gtk::Scrollable
 Scrollable ()
 

Related Functions

(Note that these are not member functions.)

Gsv::Viewwrap (GtkSourceView* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget &> ForeachSlot
 
- Public Types inherited from Gtk::Widget
typedef sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)> SlotTick
 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Static Protected Member Functions inherited from Gtk::Widget
static bool should_draw_window (const ::Cairo::RefPtr< const ::Cairo::Context > &cr, const Glib::RefPtr< const Gdk::Window > &window)
 

Detailed Description

The view object.

View is the main object of the gtksourceviewmm library. It provides a text view which has syntax highlighting, undo/redo and text marks. Use a Buffer to display text with a GtkSourceView.

Constructor & Destructor Documentation

◆ View() [1/4]

Gsv::View::View ( View&&  src)
noexcept

◆ View() [2/4]

Gsv::View::View ( const View )
delete

◆ ~View()

Gsv::View::~View ( )
overridenoexcept

◆ View() [3/4]

Gsv::View::View ( )
explicit

Creates a new View.

An empty default buffer will be created for you. If you want to specify your own buffer, consider the other constructor.

Returns
A new View.

◆ View() [4/4]

Gsv::View::View ( const Glib::RefPtr< Buffer >&  buffer)
explicit

Creates a new View widget displaying the buffer buffer.

One buffer can be shared among many widgets.

Parameters
bufferA Buffer.
Returns
: A new View.

Member Function Documentation

◆ get_auto_indent()

bool Gsv::View::get_auto_indent ( ) const

Returns whether auto indentation of text is enabled.

Returns
true if auto indentation is enabled.

◆ get_background_pattern()

BackgroundPatternType Gsv::View::get_background_pattern ( ) const

Returns the GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this view .

Returns
the GtkSourceBackgroundPatternType.

{3,16}

◆ get_completion() [1/2]

Glib::RefPtr<Completion> Gsv::View::get_completion ( )

Gets the Completion associated with this view.

Returns
The Completion associated with this view.
Since gtksourceviewmm 2.10:

◆ get_completion() [2/2]

Glib::RefPtr<const Completion> Gsv::View::get_completion ( ) const

Gets the Completion associated with this view.

Returns
The Completion associated with this view.
Since gtksourceviewmm 2.10:

◆ get_gutter() [1/2]

Glib::RefPtr<Gutter> Gsv::View::get_gutter ( Gtk::TextWindowType  window_type)

Returns the Gutter object associated with window_type for this view.

Only Gtk::TEXT_WINDOW_LEFT and Gtk::TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the gutter corresponding to Gtk::TEXT_WINDOW_LEFT.

Parameters
window_typeThe gutter window type
Returns
The Gutter.
Since gtksourceviewmm 2.10:

◆ get_gutter() [2/2]

Glib::RefPtr<const Gutter> Gsv::View::get_gutter ( Gtk::TextWindowType  window_type) const

Returns the Gutter object associated with window_type for this view.

Only Gtk::TEXT_WINDOW_LEFT and Gtk::TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the gutter corresponding to Gtk::TEXT_WINDOW_LEFT.

Parameters
window_typeThe gutter window type
Returns
The Gutter.
Since gtksourceviewmm 2.10:

◆ get_highlight_current_line()

bool Gsv::View::get_highlight_current_line ( ) const

Returns whether the current line is highlighted.

Returns
true if the current line is highlighted.

◆ get_indent_on_tab()

bool Gsv::View::get_indent_on_tab ( ) const

Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character.

Returns
true if the selection is indented when tab is pressed.
Since gtksourceviewmm 2.2:

◆ get_indent_width()

gint Gsv::View::get_indent_width ( ) const

Returns the number of spaces to use for each step of indent.

See set_indent_width() for details.

Returns
Indent width.

◆ get_insert_spaces_instead_of_tabs()

bool Gsv::View::get_insert_spaces_instead_of_tabs ( ) const

Returns whether when inserting a tabulator character it should be replaced by a group of space characters.

Returns
true if spaces are inserted instead of tabs.

◆ get_mark_attributes() [1/2]

Glib::RefPtr<MarkAttributes> Gsv::View::get_mark_attributes ( const Glib::ustring category,
int &  priority 
)

Gets attributes and priority for the category.

Parameters
categoryThe category.
priorityPlace where priority of the category will be stored.
Returns
Gtk::SourceMarkAttributes for the category. The object belongs to view, so it must not be unreffed.

◆ get_mark_attributes() [2/2]

Glib::RefPtr<const MarkAttributes> Gsv::View::get_mark_attributes ( const Glib::ustring category,
int &  priority 
) const

Gets attributes and priority for the category.

Parameters
categoryThe category.
priorityPlace where priority of the category will be stored.
Returns
Gtk::SourceMarkAttributes for the category. The object belongs to view, so it must not be unreffed.

◆ get_right_margin_position()

guint Gsv::View::get_right_margin_position ( ) const

Gets the position of the right margin.

Returns
The position of the right margin.

◆ get_show_line_marks()

bool Gsv::View::get_show_line_marks ( ) const

Returns whether line marks are displayed beside the text.

Returns
true if the line marks are displayed.
Since gtksourceviewmm 2.2:

◆ get_show_line_numbers()

bool Gsv::View::get_show_line_numbers ( ) const

Returns whether line numbers are displayed beside the text.

Returns
true if the line numbers are displayed.

◆ get_show_right_margin()

bool Gsv::View::get_show_right_margin ( ) const

Returns whether a right margin is displayed.

Returns
true if the right margin is shown.

◆ get_smart_home_end()

SmartHomeEndType Gsv::View::get_smart_home_end ( ) const

Returns a SmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.

Returns
A SmartHomeEndType value.

◆ get_source_buffer() [1/2]

Glib::RefPtr<const Buffer> Gsv::View::get_source_buffer ( ) const

Returns the GtkTextBuffer being displayed by this text view.

Returns
A Buffer.

◆ get_source_buffer() [2/2]

Glib::RefPtr<Buffer> Gsv::View::get_source_buffer ( )

Returns the GtkTextBuffer being displayed by this text view.

Returns
A Buffer.

◆ get_tab_width()

guint Gsv::View::get_tab_width ( ) const

Returns the width of tabulation in characters.

Returns
Width of tab.

◆ get_type()

static GType Gsv::View::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_visual_column()

guint Gsv::View::get_visual_column ( const Gtk::TextIter iter) const

Determines the visual column at iter taking into consideration the indent width of view.

Parameters
itera position in this view.
Returns
the visual column at iter.
Since gtksourceviewmm 3.0:

◆ gobj() [1/2]

GtkSourceView* Gsv::View::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkSourceView* Gsv::View::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ on_line_mark_activated()

virtual void Gsv::View::on_line_mark_activated ( Gtk::TextIter mark,
GdkEvent *  event 
)
protectedvirtual

This is a default handler for the signal signal_line_mark_activated().

◆ on_redo()

virtual void Gsv::View::on_redo ( )
protectedvirtual

This is a default handler for the signal signal_redo().

◆ on_undo()

virtual void Gsv::View::on_undo ( )
protectedvirtual

This is a default handler for the signal signal_undo().

◆ operator=() [1/2]

View& Gsv::View::operator= ( View&&  src)
noexcept

◆ operator=() [2/2]

View& Gsv::View::operator= ( const View )
delete

◆ property_auto_indent() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_auto_indent ( )

Whether to enable auto indentation.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_auto_indent() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_auto_indent ( ) const

Whether to enable auto indentation.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_background_pattern() [1/2]

Glib::PropertyProxy< BackgroundPatternType > Gsv::View::property_background_pattern ( )

Draw a specific background pattern on the view.

Default value: Gtk::SOURCE_BACKGROUND_PATTERN_TYPE_NONE

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_background_pattern() [2/2]

Glib::PropertyProxy_ReadOnly< BackgroundPatternType > Gsv::View::property_background_pattern ( ) const

Draw a specific background pattern on the view.

Default value: Gtk::SOURCE_BACKGROUND_PATTERN_TYPE_NONE

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_completion()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Completion> > Gsv::View::property_completion ( ) const

The completion object associated with the view.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_highlight_current_line() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_highlight_current_line ( )

Whether to highlight the current line.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_highlight_current_line() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_highlight_current_line ( ) const

Whether to highlight the current line.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_indent_on_tab() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_indent_on_tab ( )

Whether to indent the selected text when the tab key is pressed.

Default value: true

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_indent_on_tab() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_indent_on_tab ( ) const

Whether to indent the selected text when the tab key is pressed.

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_indent_width() [1/2]

Glib::PropertyProxy< int > Gsv::View::property_indent_width ( )

Number of spaces to use for each step of indent.

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_indent_width() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gsv::View::property_indent_width ( ) const

Number of spaces to use for each step of indent.

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_insert_spaces_instead_of_tabs() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_insert_spaces_instead_of_tabs ( )

Whether to insert spaces instead of tabs.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_insert_spaces_instead_of_tabs() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_insert_spaces_instead_of_tabs ( ) const

Whether to insert spaces instead of tabs.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_right_margin_position() [1/2]

Glib::PropertyProxy< guint > Gsv::View::property_right_margin_position ( )

Position of the right margin.

Default value: 80

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_right_margin_position() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gsv::View::property_right_margin_position ( ) const

Position of the right margin.

Default value: 80

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_show_line_marks() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_show_line_marks ( )

Whether to display line mark pixbufs.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_show_line_marks() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_show_line_marks ( ) const

Whether to display line mark pixbufs.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_show_line_numbers() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_show_line_numbers ( )

Whether to display line numbers.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_show_line_numbers() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_show_line_numbers ( ) const

Whether to display line numbers.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_show_right_margin() [1/2]

Glib::PropertyProxy< bool > Gsv::View::property_show_right_margin ( )

Whether to display the right margin.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_show_right_margin() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gsv::View::property_show_right_margin ( ) const

Whether to display the right margin.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_smart_home_end() [1/2]

Glib::PropertyProxy< SmartHomeEndType > Gsv::View::property_smart_home_end ( )

HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line.

Default value: Gtk::SOURCE_SMART_HOME_END_DISABLED

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_smart_home_end() [2/2]

Glib::PropertyProxy_ReadOnly< SmartHomeEndType > Gsv::View::property_smart_home_end ( ) const

HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line.

Default value: Gtk::SOURCE_SMART_HOME_END_DISABLED

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_tab_width() [1/2]

Glib::PropertyProxy< guint > Gsv::View::property_tab_width ( )

Width of a tab character expressed in spaces.

Default value: 8

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_tab_width() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gsv::View::property_tab_width ( ) const

Width of a tab character expressed in spaces.

Default value: 8

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_auto_indent()

void Gsv::View::set_auto_indent ( bool  enable = true)

If true auto-indentation of text is enabled.

When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is not a "smart indentation" where an indentation level is added or removed depending on the context.

Parameters
enableWhether to enable auto indentation.

◆ set_background_pattern()

void Gsv::View::set_background_pattern ( BackgroundPatternType  background_pattern)

Set if and how the background pattern should be displayed.

Parameters
background_patternthe GtkSourceBackgroundPatternType.

{3,16}

◆ set_highlight_current_line()

void Gsv::View::set_highlight_current_line ( bool  highlight = true)

If highlight is true the current line is highlighted.

Parameters
highlightWhether to highlight the current line.

◆ set_indent_on_tab()

void Gsv::View::set_indent_on_tab ( bool  enable = true)

If true, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the \t characters.

Shift+Tab unindents the selection.

Parameters
enableWhether to indent a block when tab is pressed.
Since gtksourceviewmm 2.2:

◆ set_indent_width()

void Gsv::View::set_indent_width ( gint  width)

Sets the number of spaces to use for each step of indent.

If width is -1, the value of the View::property_tab_width property will be used.

Parameters
widthIndent width in characters.

◆ set_insert_spaces_instead_of_tabs()

void Gsv::View::set_insert_spaces_instead_of_tabs ( bool  enable = true)

If true a tab key pressed is replaced by a group of space characters.

Of course it is still possible to insert a real \t programmatically with the Gtk::TextBuffer API.

Parameters
enableWhether to insert spaces instead of tabs.

◆ set_mark_attributes()

void Gsv::View::set_mark_attributes ( const Glib::ustring category,
const Glib::RefPtr< MarkAttributes >&  attributes,
int  priority 
)

Sets attributes and priority for the category.

Parameters
categoryThe category.
attributesMark attributes.
priorityPriority of the category.

◆ set_right_margin_position()

void Gsv::View::set_right_margin_position ( guint  margin)

Sets the position of the right margin.

Parameters
marginThe width in characters where to position the right margin.

◆ set_show_line_marks()

void Gsv::View::set_show_line_marks ( bool  show = true)

If true line marks will be displayed beside the text.

Parameters
showWhether line marks should be displayed.
Since gtksourceviewmm 2.2:

◆ set_show_line_numbers()

void Gsv::View::set_show_line_numbers ( bool  show = true)

If true line numbers will be displayed beside the text.

Parameters
showWhether line numbers should be displayed.

◆ set_show_right_margin()

void Gsv::View::set_show_right_margin ( bool  show = true)

If true a right margin is displayed.

Parameters
showWhether to show a right margin.

◆ set_smart_home_end()

void Gsv::View::set_smart_home_end ( SmartHomeEndType  smart_he)

Set the desired movement of the cursor when HOME and END keys are pressed.

Parameters
smart_heThe desired behavior among SmartHomeEndType.

◆ set_source_buffer()

void Gsv::View::set_source_buffer ( const Glib::RefPtr< Buffer >&  source_buffer)

Sets a source_buffer as the buffer being displayed by source view.

The previous buffer displayed by the text view is unreferenced, and a reference is added to buffer.

Parameters
source_bufferA Buffer.

◆ set_tab_width()

void Gsv::View::set_tab_width ( guint  width)

Sets the width of tabulation in characters.

The Gtk::TextBuffer still contains \t characters, but they can take a different visual width in a Gtk::SourceView widget.

Parameters
widthWidth of tab in characters.

◆ signal_line_mark_activated()

Glib::SignalProxy< void,Gtk::TextIter&,GdkEvent* > Gsv::View::signal_line_mark_activated ( )

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).

You can use iter to determine on which line the activation took place.

Handler parameters:
iter A Gtk::TextIter. event The GdkEvent that activated the event.
Slot Prototype:
void on_my_line_mark_activated(Gtk::TextIter& mark, GdkEvent* event)

Flags: Run Last

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). You can use mark to determine on which line the activation took place.

Parameters
markA Gtk::TextIter.
eventThe Gdk::Event that activated the event.

◆ signal_redo()

Glib::SignalProxy< void > Gsv::View::signal_redo ( )

Emitted when redo action is requested.

Slot Prototype:
void on_my_redo()

Flags: Run Last, Action

◆ signal_smart_home_end()

Glib::SignalProxy< void,Gtk::TextIter&,int > Gsv::View::signal_smart_home_end ( )

Emitted when a the cursor was moved according to the smart home end setting.

The signal is emitted after the cursor is moved, but during the Gtk::TextView::move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.

Handler parameters:
iter A Gtk::TextIter count The count
Since gtksourceviewmm 3.0:
Slot Prototype:
void on_my_smart_home_end(Gtk::TextIter& iter, int count)

Flags: Run Last

Emitted when a the cursor was moved according to the smart home end setting. The signal is emitted after the cursor is moved, but during the GtkTextView::move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.

Since gtksourceviewmm 3.0:
Parameters
iterA Gtk::TextIter.
countThe count.

◆ signal_undo()

Glib::SignalProxy< void > Gsv::View::signal_undo ( )

Emitted when undo action is requested.

Slot Prototype:
void on_my_undo()

Flags: Run Last, Action

Friends And Related Function Documentation

◆ wrap()

Gsv::View* wrap ( GtkSourceView *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

Member Data Documentation

◆ gutter_position_lines

const int Gsv::View::gutter_position_lines = -30
static

The gutter position of the lines renderer.

◆ gutter_position_marks

const int Gsv::View::gutter_position_marks = -20
static

The gutter position of the marks renderer.