gtkmm: Gdk::PopupLayout Class Reference
Information for presenting popups. More...
#include <gdkmm/popuplayout.h>
Public Member Functions | |
void | reference () const |
Increment the reference count for this object. More... | |
void | unreference () const |
Decrement the reference count for this object. More... | |
GdkPopupLayout* | gobj () |
Provides access to the underlying C instance. More... | |
const GdkPopupLayout* | gobj () const |
Provides access to the underlying C instance. More... | |
GdkPopupLayout* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
PopupLayout ()=delete | |
PopupLayout (const PopupLayout&)=delete | |
PopupLayout& | operator= (const PopupLayout&)=delete |
Glib::RefPtr< PopupLayout > | copy () const |
Create a new Gdk::PopupLayout and copy the contents of layout into it. More... | |
bool | equal (const Glib::RefPtr< const PopupLayout >& other) const |
Check whether layout and other has identical layout properties. More... | |
void | set_anchor_rect (const Rectangle& anchor_rect) |
Set the anchor rectangle. More... | |
Rectangle | get_anchor_rect () const |
Get the anchor rectangle. More... | |
void | set_rect_anchor (Gravity anchor) |
Set the anchor on the anchor rectangle. More... | |
Gravity | get_rect_anchor () const |
Returns the anchor position on the anchor rectangle. More... | |
void | set_surface_anchor (Gravity anchor) |
Set the anchor on the popup surface. More... | |
Gravity | get_surface_anchor () const |
Returns the anchor position on the popup surface. More... | |
void | set_anchor_hints (AnchorHints anchor_hints) |
Set new anchor hints. More... | |
AnchorHints | get_anchor_hints () const |
Get the Gdk::AnchorHints. More... | |
void | set_offset (int dx, int dy) |
Offset the position of the anchor rectangle with the given delta. More... | |
void | get_offset (int& dx, int& dy) |
Retrieves the offset for the anchor rectangle. More... | |
Static Public Member Functions | |
static Glib::RefPtr< PopupLayout > | create (const Rectangle& anchor_rect, Gravity rect_anchor, Gravity surface_anchor) |
Create a popup layout description. More... | |
Protected Member Functions | |
void | operator delete (void*, std::size_t) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::PopupLayout > | wrap (GdkPopupLayout* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
Information for presenting popups.
Popups are positioned relative to their parent surface. The Gdk::PopupLayout class contains information that is necessary to do so.
Constructor & Destructor Documentation
|
delete |
|
delete |
Member Function Documentation
Glib::RefPtr<PopupLayout> Gdk::PopupLayout::copy | ( | ) | const |
Create a new Gdk::PopupLayout and copy the contents of layout into it.
- Returns
- A copy of layout.
|
static |
Create a popup layout description.
Used together with present() to describe how a popup surface should be placed and behave on-screen.
anchor_rect is relative to the top-left corner of the surface's parent. rect_anchor and surface_anchor determine anchor points on anchor_rect and surface to pin together.
The position of anchor_rect's anchor point can optionally be offset using set_offset(), which is equivalent to offsetting the position of surface.
- Parameters
-
anchor_rect The anchor Gdk::Rectangle to align surface with. rect_anchor The point on anchor_rect to align with surface's anchor point. surface_anchor The point on surface to align with rect's anchor point.
- Returns
- Newly created instance of Gdk::PopupLayout.
bool Gdk::PopupLayout::equal | ( | const Glib::RefPtr< const PopupLayout >& | other | ) | const |
Check whether layout and other has identical layout properties.
- Parameters
-
other Another Gdk::PopupLayout.
- Returns
true
if layout and other have identical layout properties, otherwisefalse
.
AnchorHints Gdk::PopupLayout::get_anchor_hints | ( | ) | const |
Get the Gdk::AnchorHints.
- Returns
- The Gdk::AnchorHints.
Rectangle Gdk::PopupLayout::get_anchor_rect | ( | ) | const |
Get the anchor rectangle.
- Returns
- The anchor rectangle.
void Gdk::PopupLayout::get_offset | ( | int & | dx, |
int & | dy | ||
) |
Retrieves the offset for the anchor rectangle.
- Parameters
-
dx Return location for the delta X coordinate. dy Return location for the delta Y coordinate.
Gravity Gdk::PopupLayout::get_rect_anchor | ( | ) | const |
Returns the anchor position on the anchor rectangle.
- Returns
- The anchor on the anchor rectangle.
Gravity Gdk::PopupLayout::get_surface_anchor | ( | ) | const |
Returns the anchor position on the popup surface.
- Returns
- The anchor on the popup surface.
GdkPopupLayout* Gdk::PopupLayout::gobj | ( | ) |
Provides access to the underlying C instance.
const GdkPopupLayout* Gdk::PopupLayout::gobj | ( | ) | const |
Provides access to the underlying C instance.
GdkPopupLayout* Gdk::PopupLayout::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
protected |
|
delete |
void Gdk::PopupLayout::reference | ( | ) | const |
Increment the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
void Gdk::PopupLayout::set_anchor_hints | ( | AnchorHints | anchor_hints | ) |
Set new anchor hints.
The set anchor_hints determines how surface will be moved if the anchor points cause it to move off-screen. For example, Gdk::AnchorHints::FLIP_X will replace Gdk::Gravity::NORTH_WEST with Gdk::Gravity::NORTH_EAST and vice versa if surface extends beyond the left or right edges of the monitor.
- Parameters
-
anchor_hints The new Gdk::AnchorHints.
void Gdk::PopupLayout::set_anchor_rect | ( | const Rectangle& | anchor_rect | ) |
Set the anchor rectangle.
- Parameters
-
anchor_rect The new anchor rectangle.
void Gdk::PopupLayout::set_offset | ( | int | dx, |
int | dy | ||
) |
Offset the position of the anchor rectangle with the given delta.
- Parameters
-
dx X delta to offset the anchor rectangle with. dy Y delta to offset the anchor rectangle with.
void Gdk::PopupLayout::set_rect_anchor | ( | Gravity | anchor | ) |
Set the anchor on the anchor rectangle.
- Parameters
-
anchor The new rect anchor.
void Gdk::PopupLayout::set_surface_anchor | ( | Gravity | anchor | ) |
Set the anchor on the popup surface.
- Parameters
-
anchor The new popup surface anchor.
void Gdk::PopupLayout::unreference | ( | ) | const |
Decrement the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False 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.