gnomebg

Documentation

Index

• Variables
• type BG
  • func NewBG() *BG
  • func (bg *BG) ChangesWithTime() bool
  • func (bg *BG) ConnectChanged(f func()) coreglib.SignalHandle
  • func (bg *BG) ConnectTransitioned(f func()) coreglib.SignalHandle
  • func (bg *BG) CreateFrameThumbnail(factory *gnomedesktop.DesktopThumbnailFactory, screenArea *cairo.RectangleInt, ...) *gdkpixbuf.Pixbuf
  • func (bg *BG) CreateSurface(window gdk.Surfacer, width, height int) *cairo.Surface
  • func (bg *BG) CreateThumbnail(factory *gnomedesktop.DesktopThumbnailFactory, screenArea *cairo.RectangleInt, ...) *gdkpixbuf.Pixbuf
  • func (bg *BG) Draw(dest *gdkpixbuf.Pixbuf)
  • func (bg *BG) Filename() string
  • func (bg *BG) HasMultipleSizes() bool
  • func (bg *BG) ImageSize(factory *gnomedesktop.DesktopThumbnailFactory, bestWidth, bestHeight int, ...) bool
  • func (bg *BG) IsDark(destWidth, destHeight int) bool
  • func (bg *BG) LoadFromPreferences(settings *gio.Settings)
  • func (bg *BG) SaveToPreferences(settings *gio.Settings)
  • func (bg *BG) SetFilename(filename string)
• type BGSlideShow
  • func NewBGSlideShow(filename string) *BGSlideShow
  • func (self *BGSlideShow) CurrentSlide(width, height int) (progress, duration float64, isFixed bool, file1, file2 string)
  • func (self *BGSlideShow) HasMultipleSizes() bool
  • func (self *BGSlideShow) Load() error
  • func (self *BGSlideShow) NumSlides() int
  • func (self *BGSlideShow) Slide(frameNumber, width, height int) (progress, duration float64, isFixed bool, file1, file2 string, ok bool)
  • func (self *BGSlideShow) StartTime() float64
  • func (self *BGSlideShow) TotalDuration() float64
• type BGSlideShowClass
• type BGSlideShowOverrides

Variables

var (
	GTypeBG = coreglib.Type(C.gnome_bg_get_type())
)

GType values.

var (
	GTypeBGSlideShow = coreglib.Type(C.gnome_bg_slide_show_get_type())
)

GType values.

Types

type BG

type BG struct {
	*coreglib.Object
	// contains filtered or unexported fields
}

func NewBG

func NewBG() *BG

The function returns the following values:

func (*BG) ChangesWithTime

func (bg *BG) ChangesWithTime() bool

The function returns the following values:

func (*BG) ConnectChanged

func (bg *BG) ConnectChanged(f func()) coreglib.SignalHandle

func (*BG) ConnectTransitioned

func (bg *BG) ConnectTransitioned(f func()) coreglib.SignalHandle

func (*BG) CreateFrameThumbnail

func (bg *BG) CreateFrameThumbnail(factory *gnomedesktop.DesktopThumbnailFactory, screenArea *cairo.RectangleInt, destWidth, destHeight, frameNum int) *gdkpixbuf.Pixbuf

CreateFrameThumbnail creates a thumbnail for a certain frame, where 'frame' is somewhat vaguely defined as 'suitable point to show while single-stepping through the slideshow'.

The function takes the following parameters:

• factory
• screenArea
• destWidth
• destHeight
• frameNum

The function returns the following values:

• pixbuf: newly created thumbnail or or NULL if frame_num is out of bounds.

func (*BG) CreateSurface

func (bg *BG) CreateSurface(window gdk.Surfacer, width, height int) *cairo.Surface

CreateSurface: create a surface that can be set as background for window.

The function takes the following parameters:

• window
• width
• height

The function returns the following values:

• surface: NULL on error (e.g. out of X connections).

func (*BG) CreateThumbnail

func (bg *BG) CreateThumbnail(factory *gnomedesktop.DesktopThumbnailFactory, screenArea *cairo.RectangleInt, destWidth, destHeight int) *gdkpixbuf.Pixbuf

The function takes the following parameters:

• factory
• screenArea
• destWidth
• destHeight

The function returns the following values:

• pixbuf showing the background as a thumbnail.

func (*BG) Draw

func (bg *BG) Draw(dest *gdkpixbuf.Pixbuf)

The function takes the following parameters:

func (*BG) Filename

func (bg *BG) Filename() string

The function returns the following values:

func (*BG) HasMultipleSizes

func (bg *BG) HasMultipleSizes() bool

The function returns the following values:

func (*BG) ImageSize

func (bg *BG) ImageSize(factory *gnomedesktop.DesktopThumbnailFactory, bestWidth, bestHeight int, width, height *int) bool

The function takes the following parameters:

• factory
• bestWidth
• bestHeight
• width
• height

The function returns the following values:

func (*BG) IsDark

func (bg *BG) IsDark(destWidth, destHeight int) bool

The function takes the following parameters:

• destWidth
• destHeight

The function returns the following values:

func (*BG) LoadFromPreferences

func (bg *BG) LoadFromPreferences(settings *gio.Settings)

The function takes the following parameters:

func (*BG) SaveToPreferences

func (bg *BG) SaveToPreferences(settings *gio.Settings)

The function takes the following parameters:

func (*BG) SetFilename

func (bg *BG) SetFilename(filename string)

The function takes the following parameters:

type BGSlideShow

type BGSlideShow struct {
	*coreglib.Object
	// contains filtered or unexported fields
}

func NewBGSlideShow

func NewBGSlideShow(filename string) *BGSlideShow

NewBGSlideShow creates a new object to manage a slide show. window background between two #cairo_surface_ts.

The function takes the following parameters:

• filename of the slide show.

The function returns the following values:

• bgSlideShow: new BGSlideShow.

func (*BGSlideShow) CurrentSlide

func (self *BGSlideShow) CurrentSlide(width, height int) (progress, duration float64, isFixed bool, file1, file2 string)

CurrentSlide returns the current slides progress.

The function takes the following parameters:

• width: monitor width.
• height: monitor height.

The function returns the following values:

• progress (optional): slide progress.
• duration (optional): slide duration.
• isFixed (optional): if slide is fixed.
• file1 (optional): first file in slide.
• file2 (optional): second file in slide.

func (*BGSlideShow) HasMultipleSizes

func (self *BGSlideShow) HasMultipleSizes() bool

HasMultipleSizes gets whether or not the slide show has multiple sizes for different monitors.

The function returns the following values:

• ok: TRUE if multiple sizes.

func (*BGSlideShow) Load

func (self *BGSlideShow) Load() error

Load tries to load the slide show.

func (*BGSlideShow) NumSlides

func (self *BGSlideShow) NumSlides() int

NumSlides returns number of slides in slide show.

The function returns the following values:

func (*BGSlideShow) Slide

func (self *BGSlideShow) Slide(frameNumber, width, height int) (progress, duration float64, isFixed bool, file1, file2 string, ok bool)

Slide retrieves slide by frame number.

The function takes the following parameters:

• frameNumber: frame number.
• width: monitor width.
• height: monitor height.

The function returns the following values:

• progress (optional): slide progress.
• duration (optional): slide duration.
• isFixed (optional): if slide is fixed.
• file1 (optional): first file in slide.
• file2 (optional): second file in slide.
• ok: TRUE if successful.

func (*BGSlideShow) StartTime

func (self *BGSlideShow) StartTime() float64

StartTime gets the start time of the slide show.

The function returns the following values:

• gdouble: timestamp.

func (*BGSlideShow) TotalDuration

func (self *BGSlideShow) TotalDuration() float64

TotalDuration gets the total duration of the slide show.

The function returns the following values:

• gdouble: timestamp.

type BGSlideShowClass

type BGSlideShowClass struct {
	// contains filtered or unexported fields
}

BGSlideShowClass: instance of this type is always passed by reference.

type BGSlideShowOverrides

type BGSlideShowOverrides struct {
}

BGSlideShowOverrides contains methods that are overridable.