GOffice.GraphView¶
Methods¶
- Inherited:
- Structs:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
w |
The |
||
w |
the |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
allocation |
r |
||
allocation_valid |
r |
||
base |
r |
||
being_updated |
r |
||
child_allocations_valid |
r |
||
children |
[ |
r |
|
model |
r |
||
parent |
r |
||
renderer |
r |
||
residual |
r |
||
toolkit |
[ |
r |
Class Details¶
- class GOffice.GraphView(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
- find_child_view(target_model)¶
- Parameters:
target_model (
GOffice.GraphObject
) –GOffice.GraphObject
- Returns:
None
on error or if target_model has no view.- Return type:
Find the
GOffice.GraphView
contained in self that corresponds to model.
- get_model()¶
- Returns:
the
GOffice.GraphObject
owning the view.- Return type:
- get_natural_size(requisition)¶
- Parameters:
requisition (
GOffice.GraphViewRequisition
) –
- get_tip_at_point(x, y)¶
- Parameters:
- Returns:
the newly allocated tip string if the view class supports that or
None
.- Return type:
Gets a tip string related to the position as defined by (x,`y`) in self.
- get_tool_at_point(x, y, gobj)¶
- Parameters:
x (
float
) – inGOffice.coords
y (
float
) – inGOffice.coords
gobj (
GOffice.GraphObject
) – pointed object orNone
- Returns:
tool under cursor for a given view, or
None
- Return type:
- get_toolkit()¶
- Returns:
toolkit associated with given view.
- Return type:
- get_view_at_point(x, y, obj, tool)¶
- Parameters:
x (
float
) – cursor x positiony (
float
) – cursor y positionobj (
GOffice.GraphObject
) – pointed object orNone
tool (
GOffice.GraphTool
) – pointed tool orNone
- Returns:
the
GOffice.GraphView
at x,y position- Return type:
Gets view under cursor, searching recursively from self. Corresponding object is stored in obj. This object may or may not be self->model of pointed view. This function also stores tool under cursor, for the pointed view.
- padding_request(bbox, padding)¶
- Parameters:
bbox (
GOffice.GraphViewAllocation
) –padding (
GOffice.GraphViewPadding
) –
- queue_redraw()¶
Requests a redraw for the entire graph.
- queue_resize()¶
Flags a view to have its size renegotiated; should be called when a model for some reason has a new size request. For example, when you change the size of a legend.
- render(bbox)¶
- Parameters:
bbox (
GOffice.GraphViewAllocation
) –
- render_toolkit()¶
Render toolkit elements.
- size_allocate(allocation)¶
- Parameters:
allocation (
GOffice.GraphViewAllocation
) – position and size to be allocated to self
Assign a size and position to a
GOffice.GraphView
. Primarilly used by containers.
- size_child_request(available, req, min_req)¶
- Parameters:
available (
GOffice.GraphViewRequisition
) – the amount of space available in totalreq (
GOffice.GraphViewRequisition
) – additionnal requisitionmin_req (
GOffice.GraphViewRequisition
) – minimum size for displaying all children
Computes additional requision in req which must be added to parent requisition, and minimum requisition in min_req which is minimum space for displaying all children.
- size_request(available, requisition)¶
- Parameters:
available (
GOffice.GraphViewRequisition
) – available space.requisition (
GOffice.GraphViewRequisition
) – aGOffice.GraphViewRequisition
.
Determines the desired size of a view.
Note, that the virtual method deviates slightly from this function. This function will zero requisition before calling the virtual method.
Remember that the size request is not necessarily the size a view will actually be allocated.
- do_build_toolkit() virtual¶
- do_get_tip_at_point(x, y) virtual¶
- Parameters:
- Returns:
the newly allocated tip string if the view class supports that or
None
.- Return type:
Gets a tip string related to the position as defined by (x,`y`) in view.
- do_natural_size(req) virtual¶
- Parameters:
req (
GOffice.GraphViewRequisition
) –
- do_padding_request(bbox, padding) virtual¶
- Parameters:
bbox (
GOffice.GraphViewAllocation
) –padding (
GOffice.GraphViewPadding
) –
- do_render(bbox) virtual¶
- Parameters:
bbox (
GOffice.GraphViewAllocation
) –
- do_reserved1() virtual¶
- do_reserved2() virtual¶
- do_size_allocate(allocation) virtual¶
- Parameters:
allocation (
GOffice.GraphViewAllocation
) – position and size to be allocated to view
Assign a size and position to a
GOffice.GraphView
. Primarilly used by containers.
- do_size_request(available, requisition) virtual¶
- Parameters:
available (
GOffice.GraphViewRequisition
) – available space.requisition (
GOffice.GraphViewRequisition
) – aGOffice.GraphViewRequisition
.
Determines the desired size of a view.
Note, that the virtual method deviates slightly from this function. This function will zero requisition before calling the virtual method.
Remember that the size request is not necessarily the size a view will actually be allocated.
- do_state_init() virtual¶
Property Details¶
- GOffice.GraphView.props.model¶
- Name:
model
- Type:
- Default Value:
- Flags:
The
GOffice.GraphObject
this view displays
- GOffice.GraphView.props.parent¶
- Name:
parent
- Type:
- Default Value:
- Flags:
the
GOffice.GraphView
parent