Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
_DateChooser_Colors
_DateChooser_Data
_DateChooser_Date
_DocumentItem
_DocumentLayout
_FilePropertiesData
_IconPanelContainer
_TabPanelContainer
_ToolPanelContainer
_WizardContainer
Balloon
Bookmarks
ButtonBox
ColorButton
ColorChooser
ColorPalette
Completion
DateBox
DateChooser
DirBox
DirBrowser
DirChooser
DirView
DocumentView
Expander
FileBox
FileChooser
FileCompletion
FileProperties
FileView
FontBox
FontChooser
IconPanel
ImageView
InputBox
LCDLabel
ListContainer
ListEditor
MaskBox
MenuButton
Message
MessageView
SidePanel
_new
Action
Border
Design
Dimension
Hidden
Hide
MinSize
Orientation
Resizable
Resize
Separator
Settings
Show
Tooltip
Transparent
Value
SliderBox
SpinBar
Spinner
Stock
SwitchButton
TableView
TabPanel
TimeBox
ToolPanel
URLLabel
ValueBox
Wizard
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

SidePanel (gb.form)

This control implements a container that can be hidden or resized.

A SidePanel should be put on one side of its parent, according to the value of its Orientation property.

  • It is hidden or shown when the user clicks on one of the two small arrow buttons displayed on its border.

  • It is resized when the users clicks on the border between the buttons, and moves the mouse.

This class inherits UserContainer in gb.qt4.

This class is creatable.

Properties
Action   Returns or sets the action associated with the control.
AutoHide   Return or set if the side panel is automatically hidden after a short time.
Border   Returns or sets if a sunken border should be displayed.
Design   Indicates that the control is in design mode.
Dimension   Return or set the dimension of the SidePanel, i.e. its width if it is horizontal, or its height if it is vertical.
Hidden   Returns or sets if the SidePanel is hidden or not.
MinSize   Returns or sets the minimum size (height or width depending on Orientation) the the user can shrink the sidepanel to before it momentarily pauses in its resizing. This is to prevent inadvertent closure of the panel by clumsy users.
Orientation   Returns or sets the SidePanel orientation.
Resizable   Returns or sets if the SidePanel is resizable.
Separator   Return or set if the SidePanel displays a Separator on its border.
Settings   Returns or sets a string that represents the geometry of the SidePanel.
ShowButtons   Return or set if the little arrow buttons that toggle the panels should be visible.
Tooltip   Returns or sets the tooltip displayed when the mouse is over the SidePanel border.
Transparent   Return or set if the SidePanel handle is transparent or visible.
Value   This property is the exact contrary of the Hidden property.

Inherited properties
Arrangement   Returns or sets how this container arrange its children controls.
AutoResize   Indicates that the container automatically resizes to the size of its contents.
Background   Returns or sets the background color used by the control.
Centered   Center controls horizontally or vertically according to the container arrangement.
Children   Returns a collection of each control included in the container.
ClientH   A synonymous for the ClientHeight property.
ClientHeight   Returns the height of the area containing the controls.
ClientW   A synonymous for the ClientWidth property.
ClientWidth   Returns the width of the area containing the controls.
ClientX   Returns the position of the left border of the area containing the controls.
ClientY   Returns the position of the top border of the area containing the controls.
Cursor   Use this property for assigning a custom cursor to a control.
Direction   Return or set the control text direction.
Drop   Returns or sets if a control accepts drops.
Enabled   Indicates that the control is enabled.
Expand   Returns or sets if a control will expand if included in a container that arranges its contents.
Font   Returns or sets the font used to draw text in the control.
Foreground   Returns or sets the foreground color used by the control.
H   A synonymous for the Height property.
Handle   Returns the internal X11 window handle of the control.
HasFocus   Returns whether the control has the focus.
Height   Returns or sets the height of the control.
Hovered   Returns whether the mouse cursor is inside the control.
Id   A synonymous for the Handle property.
Ignore   Returns or sets if a control must be ignored when its parent arranges its children.
Indent   Returns or sets if the children controls of the container are indented.
Invert   Return or set if the horizontal or vertical arrangement direction is inverted.
Left   Returns or sets the position of the left border of the control relative to its parent.
Margin   Returns or sets if there is a margin between the container border and all its children.
Mouse   Returns or sets the appearence of the cursor when it points inside the control.
Name   Returns or sets the name of the control.
Next   Returns the next control having the same parent.
NoTabFocus   Return or set if a control cannot be focused with the TAB key.
Padding   Returns or sets the number of pixels used as space between children controls, or container inner margin.
Parent   Returns the control container.
PopupMenu   Return or set the name of the menu that will be popped-up when the user presses the right mouse button or the keyboard MENU key.
Previous   Returns the previous control having the same parent.
Proxy   Return or set the "proxy" of a control.
RightToLeft   Return if the control is right to left oriented.
ScreenX   Returns the position of the left border of the control in screen coordinates.
ScreenY   Returns the position of the top border of the control in screen coordinates.
Spacing   Returns or sets if the children of the container are spaced out.
Tag   Returns or sets the control tag.
Top   Returns or sets the position of the top border of the control relative to its parent.
Tracking   Returns or sets if the control will receive MouseMove events.
Visible   Indicates if the control is visible or not.
W   A synonymous for the Width property.
Width   Returns or sets the width of the control.
Window   Returns the top-level window that contains the control.
X   Returns or sets the position of the left border of the control relative to its parent.
Y   Returns or sets the position of the top border of the control relative to its parent.

Inherited methods
Delete   Destroys the control.
Drag   Starts a drag & drop process.
FindChild   Finds the first child control pointed by the X and Y coordinates.
Grab   Grab the keyboard and the mouse so that all keyboard and mouse events are received by the control.
Hide   Hides the control.
Lower   Sends the control to the background of its parent.
Move   Moves and/or resizes the control.
MoveScaled   Moves and/or resizes the control.
Raise   Sends the control to the foreground of its parent.
Refresh   Trigger a redraw of the control.
Reparent   Changes the container of a control.
Resize   Resizes the control.
ResizeScaled   Resizes the control.
SetFocus   Gives the focus to the control.
Show   Shows the control.

Events
Hide   This event is raised just after the SidePanel has been hidden.
Resize   This event is raised when the SidePanel is resized.
Show   This event is raised just before the SidePanel is shown.

Inherited events
Arrange   This event is raised when a container has just finished arranging its contents.
BeforeArrange   This event is raised just before a container arranges its contents.
DblClick   Raised when the user quickly clicks twice on the control.
Drag   This event is raised when the mouse enters the control during a drag & drop process.
DragLeave   This event is raised when the mouse leaves the control during a drag & drop operation.
DragMove   This event is raised while the mouse moves inside the control during a drag & drop process.
Drop   This event is raised when a drag is dropped in the control.
Enter   Raised when the mouse enters the control.
GotFocus   Raised when the control has got the focus.
KeyPress   Raised when a key is pressed while the control has the focus.
KeyRelease   Raised when a key is released while the control has the focus.
Leave   Raised when the mouse leaves the control.
LostFocus   Raised when the control has lost the focus.
Menu   Raised when the user clicks on the control with the right mouse button, or if it hits the MENU key.
MouseDown   Raised when a mouse button is pressed while the cursor is inside the control.
MouseDrag   This event is raised when a drag operation should be started.
MouseMove   Raised when the mouse moves inside the control while a mouse button is pressed.
MouseUp   Raised when a mouse button is depressed while the cursor is inside the control.
MouseWheel   This event is raised when the user moves or presses the mouse wheel while the mouse is inside the control.
NewChild   This event is raised when a new child Control has just been inserted into the container.