Package org.gnome.gtk

Class StringList

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.StringList

All Implemented Interfaces:

Iterable<StringObject>, Collection<StringObject>, List<StringObject>, SequencedCollection<StringObject>, ListModel<StringObject>, Buildable, Proxy, ListModelJavaList<StringObject>, ListModelJavaListMutable<StringObject>, ListModelJavaListSpliceable<StringObject>

@Generated("io.github.jwharm.JavaGI")
public class StringList
extends GObject
implements ListModel<StringObject>, Buildable, ListModelJavaListSpliceable<StringObject>

A list model that wraps an array of strings.

The objects in the model are of type StringObject and have a "string" property that can be used inside expressions.

GtkStringList is well-suited for any place where you would typically use a char*[], but need a list model.

GtkStringList as GtkBuildable
The GtkStringList implementation of the GtkBuildable interface supports adding items directly using the <items> element and specifying <item> elements for each item. Each <item> element supports the regular translation attributes “translatable”, “context” and “comments”.

Here is a UI definition fragment specifying a GtkStringList

<object class="GtkStringList">
   <items>
     <item translatable="yes">Factory</item>
     <item translatable="yes">Home</item>
     <item translatable="yes">Subway</item>
   </items>
 </object>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringList.Builder<B extends StringList.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	StringList.StringListClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gio.ListModel

ListModel.ItemsChangedCallback, ListModel.ListModel$Impl, ListModel.ListModelInterface

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList

ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>>

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaListSpliceable

ListModelJavaListSpliceable.SubList<E extends @Nullable GObject,List extends ListModelJavaListSpliceable<E>>

Constructor Summary

Constructors

Constructor	Description
StringList()	Creates a new StringList.
StringList(@Nullable String @Nullable [] strings)	Creates a new GtkStringList with the given strings.
StringList(MemorySegment address)	Create a StringList proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	append(String string)	Appends string to self.
void	append(StringObject e)	Adds the specified element to the end of this list.
protected StringList	asParent()	Returns this instance as if it were its parent type.
static StringList.Builder<? extends StringList.Builder>	builder()	A StringList.Builder object constructs a StringList with the specified properties.
int	find(String string)	Gets the position of the string in self.
@Nullable String	getString(int position)	Gets the string that is at position in self.
static @Nullable Type	getType()	Get the GType of the StringList class
void	removeAt(int position)	Removes the string at position from self.
void	splice(int position, int nRemovals, @Nullable String @Nullable [] additions)	Changes this StringList by removing nRemovals strings and adding additions to it.
void	splice(int index, int nRemovals, Collection<? extends StringObject> additions)	Modifies this list by removing nRemovals elements starting at index and replacing them with the elements in additions.
void	splice(int index, int nRemovals, StringObject[] additions)	Modifies this list by removing nRemovals elements starting at index and replacing them with the elements in additions.
void	take(String string)	Adds string to self at the end, and takes ownership of it.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.gnome.gio.ListModel

emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged

Methods inherited from interface org.javagi.gio.ListModelJavaList

contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface org.javagi.gio.ListModelJavaListMutable

add, remove

Methods inherited from interface org.javagi.gio.ListModelJavaListSpliceable

add, addAll, addAll, clear, set, subList

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

StringList

public StringList(MemorySegment address)

Create a StringList proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

StringList

public StringList(@Nullable String @Nullable [] strings)

Creates a new GtkStringList with the given strings.

Parameters:

strings - The strings to put in the model

StringList

public StringList()

Creates a new StringList.

Method Details

splice

public void splice(int index,
 int nRemovals,
 Collection<? extends StringObject> additions)

Modifies this list by removing nRemovals elements starting at index and replacing them with the elements in additions.

Specified by:

splice in interface ListModelJavaListSpliceable<StringObject>

Parameters:

index - the index at which to splice the list

nRemovals - the number of elements to remove

additions - the elements to insert at the index

Throws:

IndexOutOfBoundsException - if the index is out of range

splice

public void splice(int index,
 int nRemovals,
 StringObject[] additions)

Modifies this list by removing nRemovals elements starting at index and replacing them with the elements in additions.

Specified by:

splice in interface ListModelJavaListSpliceable<StringObject>

Parameters:

index - the index at which to splice the list

nRemovals - the number of elements to remove

additions - the elements to insert at the index

Throws:

IndexOutOfBoundsException - if the index is out of range

append

public void append(StringObject e)

Adds the specified element to the end of this list.

Specified by:

append in interface ListModelJavaListMutable<StringObject>

Parameters:

e - element to be appended to this list

getType

public static @Nullable Type getType()

Get the GType of the StringList class

Returns:

the GType

asParent

protected StringList asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

append

public void append(String string)

Appends string to self.

The string will be copied. See take(java.lang.String) for a way to avoid that.

Parameters:

string - the string to insert

find

public int find(String string)

Gets the position of the string in self.

If this StringList does not contain string item, G_MAXUINT is returned.

Parameters:

string - the string to find

Returns:

the position of the string

Since:

4.18

getString

public @Nullable String getString(int position)

Gets the string that is at position in self.

If this StringList does not contain position items, null is returned.

This function returns the const char *. To get the object wrapping it, use g_list_model_get_item().

Parameters:

position - the position to get the string for

Returns:

the string at the given position

removeAt

public void removeAt(int position)

Removes the string at position from self.

position must be smaller than the current length of the list.

Specified by:

removeAt in interface ListModelJavaListMutable<StringObject>

Parameters:

position - the position of the string that is to be removed

splice

public void splice(int position,
 int nRemovals,
 @Nullable String @Nullable [] additions)

Changes this StringList by removing nRemovals strings and adding additions to it.

This function is more efficient than append(org.gnome.gtk.StringObject) and StringList#remove, because it only emits the ::items-changed signal once for the change.

This function copies the strings in additions.

The parameters position and nRemovals must be correct (ie: position + nRemovals must be less than or equal to the length of the list at the time this function is called).

Parameters:

position - the position at which to make the change

nRemovals - the number of strings to remove

additions - The strings to add

take

public void take(String string)

Adds string to self at the end, and takes ownership of it.

This variant of append(org.gnome.gtk.StringObject) is convenient for formatting strings:

gtk_string_list_take (self, g_strdup_print ("%d dollars", lots));
 

Parameters:

string - the string to insert

builder

public static StringList.Builder<? extends StringList.Builder> builder()

A StringList.Builder object constructs a StringList with the specified properties. Use the various set...() methods to set properties, and finish construction with StringList.Builder.build().

Returns:

the builder object